devextreme
Version:
HTML5 JavaScript Component Suite for Responsive Web Development
233 lines (232 loc) • 10.7 kB
JavaScript
/**
* DevExtreme (esm/exporter/exceljs/export.js)
* Version: 24.2.6
* Build date: Mon Mar 17 2025
*
* Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
import {
isDefined,
isString,
isDate,
isObject
} from "../../core/utils/type";
import {
ExportFormat
} from "./export_format";
import {
extend
} from "../../core/utils/extend";
import {
ExportLoadPanel
} from "../common/export_load_panel";
import {
hasWindow
} from "../../core/utils/window";
const MAX_DIGIT_WIDTH_IN_PIXELS = 7;
const MAX_EXCEL_COLUMN_WIDTH = 255;
export const Export = {
getFullOptions(options) {
const fullOptions = extend({}, options);
if (!(isDefined(fullOptions.worksheet) && isObject(fullOptions.worksheet))) {
throw Error('The "worksheet" field must contain an object.')
}
if (!isDefined(fullOptions.topLeftCell)) {
fullOptions.topLeftCell = {
row: 1,
column: 1
}
} else if (isString(fullOptions.topLeftCell)) {
const {
row: row,
col: col
} = fullOptions.worksheet.getCell(fullOptions.topLeftCell);
fullOptions.topLeftCell = {
row: row,
column: col
}
}
if (!isDefined(fullOptions.keepColumnWidths)) {
fullOptions.keepColumnWidths = true
}
if (!isDefined(fullOptions.loadPanel)) {
fullOptions.loadPanel = {}
}
if (!isDefined(fullOptions.loadPanel.enabled)) {
fullOptions.loadPanel.enabled = true
}
if (!isDefined(fullOptions.encodeExecutableContent)) {
fullOptions.encodeExecutableContent = false
}
return fullOptions
},
convertDateForExcelJS: date => new Date(Date.UTC(date.getFullYear(), date.getMonth(), date.getDate(), date.getHours(), date.getMinutes(), date.getSeconds(), date.getMilliseconds())),
setNumberFormat(excelCell, numberFormat) {
excelCell.numFmt = numberFormat
},
getCellStyles(dataProvider) {
const styles = dataProvider.getStyles();
styles.forEach((style => {
let numberFormat = this.tryConvertToExcelNumberFormat(style.format, style.dataType);
if (isDefined(numberFormat)) {
numberFormat = numberFormat.replace(/"/g, '"')
}
style.numberFormat = numberFormat
}));
return styles
},
tryConvertToExcelNumberFormat(format, dataType) {
const newFormat = ExportFormat.formatObjectConverter(format, dataType);
const currency = newFormat.currency;
format = newFormat.format;
dataType = newFormat.dataType;
return ExportFormat.convertFormat(format, newFormat.precision, dataType, currency)
},
setAlignment(excelCell, wrapText, horizontalAlignment) {
excelCell.alignment = excelCell.alignment ?? {};
if (isDefined(wrapText)) {
excelCell.alignment.wrapText = wrapText
}
if (isDefined(horizontalAlignment)) {
excelCell.alignment.horizontal = horizontalAlignment
}
excelCell.alignment.vertical = "top"
},
setColumnsWidth(worksheet, widths, startColumnIndex) {
if (!isDefined(widths)) {
return
}
for (let i = 0; i < widths.length; i++) {
const columnWidth = widths[i];
if ("number" === typeof columnWidth && isFinite(columnWidth)) {
worksheet.getColumn(startColumnIndex + i).width = Math.min(255, Math.floor(columnWidth / 7 * 100) / 100)
}
}
},
export (options, Helpers, getLoadPanelTargetElement, getLoadPanelContainer) {
var _component$_getIntern;
const {
component: component,
worksheet: worksheet,
topLeftCell: topLeftCell,
keepColumnWidths: keepColumnWidths,
selectedRowsOnly: selectedRowsOnly,
loadPanel: loadPanel,
encodeExecutableContent: encodeExecutableContent
} = options;
const dataProvider = component.getDataProvider(selectedRowsOnly);
const internalComponent = (null === (_component$_getIntern = component._getInternalInstance) || void 0 === _component$_getIntern ? void 0 : _component$_getIntern.call(component)) || component;
const initialLoadPanelEnabledOption = internalComponent.option("loadPanel") && internalComponent.option("loadPanel").enabled;
if (initialLoadPanelEnabledOption) {
component.option("loadPanel.enabled", false)
}
let exportLoadPanel;
if (loadPanel.enabled && hasWindow()) {
const $targetElement = getLoadPanelTargetElement(component);
const $container = getLoadPanelContainer(component);
exportLoadPanel = new ExportLoadPanel(component, $targetElement, $container, loadPanel);
exportLoadPanel.show()
}
const wrapText = !!component.option("wordWrapEnabled");
worksheet.properties.outlineProperties = {
summaryBelow: false,
summaryRight: false
};
const cellRange = {
from: {
row: topLeftCell.row,
column: topLeftCell.column
},
to: {
row: topLeftCell.row,
column: topLeftCell.column
}
};
return new Promise((resolve => {
dataProvider.ready().done((() => {
const columns = dataProvider.getColumns();
const dataRowsCount = dataProvider.getRowsCount();
const helpers = new Helpers(component, dataProvider, worksheet, options);
if (keepColumnWidths) {
this.setColumnsWidth(worksheet, dataProvider.getColumnsWidths(), cellRange.from.column)
}
helpers._exportAllFieldHeaders(columns, this.setAlignment);
const fieldHeaderRowsCount = helpers._getFieldHeaderRowsCount();
cellRange.to.row = cellRange.from.row + fieldHeaderRowsCount;
const styles = this.getCellStyles(dataProvider);
for (let rowIndex = 0; rowIndex < dataRowsCount; rowIndex++) {
const currentRowIndex = cellRange.from.row + fieldHeaderRowsCount + rowIndex;
const row = worksheet.getRow(currentRowIndex);
let startColumnIndex = 0;
if (helpers._isRowFieldHeadersRow(rowIndex)) {
startColumnIndex = dataProvider.getRowAreaColCount();
helpers._exportFieldHeaders("row", currentRowIndex, 0, startColumnIndex, this.setAlignment)
}
helpers._trySetOutlineLevel(row, rowIndex);
this.exportRow(dataProvider, helpers, row, rowIndex, startColumnIndex, columns.length, wrapText, styles, encodeExecutableContent);
cellRange.to.row = currentRowIndex
}
helpers.mergedRangesManager.applyMergedRages();
cellRange.to.column += columns.length > 0 ? columns.length - 1 : 0;
const worksheetViewSettings = worksheet.views[0] || {};
if (component.option("rtlEnabled")) {
worksheetViewSettings.rightToLeft = true
}
if (helpers._isFrozenZone(dataProvider)) {
if (-1 === Object.keys(worksheetViewSettings).indexOf("state")) {
extend(worksheetViewSettings, helpers._getWorksheetFrozenState(cellRange))
}
helpers._trySetAutoFilter(cellRange)
}
if (Object.keys(worksheetViewSettings).length > 0) {
worksheet.views = [worksheetViewSettings]
}
resolve(cellRange)
})).always((() => {
if (initialLoadPanelEnabledOption) {
component.option("loadPanel.enabled", initialLoadPanelEnabledOption)
}
if (loadPanel.enabled && hasWindow()) {
exportLoadPanel.dispose()
}
}))
}))
},
exportRow(dataProvider, helpers, row, rowIndex, startColumnIndex, columnsCount, wrapText, styles, encodeExecutableContent) {
for (let cellIndex = startColumnIndex; cellIndex < columnsCount; cellIndex++) {
const cellData = dataProvider.getCellData(rowIndex, cellIndex, true);
const excelCell = row.getCell(helpers._getFirstColumnIndex() + cellIndex);
helpers.mergedRangesManager.updateMergedRanges(excelCell, rowIndex, cellIndex, helpers);
const cellInfo = helpers.mergedRangesManager.findMergedCellInfo(rowIndex, cellIndex, helpers._isHeaderCell(rowIndex, cellIndex));
if (isDefined(cellInfo) && excelCell !== cellInfo.masterCell) {
excelCell.style = cellInfo.masterCell.style;
excelCell.value = cellInfo.masterCell.value
} else {
if (isDate(cellData.value)) {
excelCell.value = this.convertDateForExcelJS(cellData.value)
} else {
excelCell.value = cellData.value
}
if (isDefined(excelCell.value)) {
const {
bold: bold,
alignment: horizontalAlignment,
numberFormat: numberFormat
} = styles[dataProvider.getStyleId(rowIndex, cellIndex)];
if (isDefined(numberFormat)) {
this.setNumberFormat(excelCell, numberFormat)
} else if (isString(excelCell.value) && /^[@=+-]/.test(excelCell.value)) {
this.setNumberFormat(excelCell, "@")
}
helpers._trySetFont(excelCell, bold);
this.setAlignment(excelCell, wrapText, horizontalAlignment)
}
}
helpers._customizeCell(excelCell, cellData.cellSourceData);
if (encodeExecutableContent) {
excelCell.value = ExportFormat.encode(excelCell.value)
}
}
}
};