ag-grid-enterprise/src/exporter/excelXlsxFactory.ts

ag-Grid Enterprise Features

import {Autowired, Bean, XmlFactory, XmlElement} from 'ag-grid-community';

import coreFactory from './files/ooxml/core';
import contentTypesFactory from './files/ooxml/contentTypes';
import officeThemeFactory from './files/ooxml/themes/office';
import sharedStringsFactory from './files/ooxml/sharedStrings';
import stylesheetFactory, {registerStyles} from './files/ooxml/styles/stylesheet';
import workbookFactory from './files/ooxml/workbook';
import worksheetFactory from './files/ooxml/worksheet';
import relationshipsFactory from './files/ooxml/relationships';

import {ExcelStyle, ExcelWorksheet} from 'ag-grid-community';

/**
 * See https://www.ecma-international.org/news/TC45_current_work/OpenXML%20White%20Paper.pdf
 */
@Bean('excelXlsxFactory')
export class ExcelXlsxFactory {

    @Autowired('xmlFactory') private xmlFactory: XmlFactory;

    private sharedStrings: string[] = [];
    private sheetNames: string[];

    public createSharedStrings(): string {
        return this.createXmlPart(sharedStringsFactory.getTemplate(this.sharedStrings));
    }

    private createXmlPart(body: XmlElement): string {
        const header = this.xmlFactory.createHeader({
            encoding: 'UTF-8',
            standalone: 'yes'
        });

        const xmlBody = this.xmlFactory.createXml(body);
        return `${header}${xmlBody}`;
    }

    public createExcel(styles: ExcelStyle[], worksheets: ExcelWorksheet[], sharedStrings: string[] = []): string {
        this.sharedStrings = sharedStrings;
        this.sheetNames = worksheets.map(worksheet => worksheet.name);

        registerStyles(styles);

        return this.createWorksheet(worksheets);
    }

    public createCore(): string {
        return this.createXmlPart(coreFactory.getTemplate());
    }

    public createContentTypes(): string {
        return this.createXmlPart(contentTypesFactory.getTemplate());
    }

    public createRels(): string {
        const rs = relationshipsFactory.getTemplate([{
            Id: 'rId1',
            Type: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument',
            Target: 'xl/workbook.xml'
        },{
            Id: 'rId2',
            Type: 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties',
            Target: 'docProps/core.xml'
        }]);

        return this.createXmlPart(rs);
    }

    public createStylesheet(): string {
        return this.createXmlPart(stylesheetFactory.getTemplate());
    }

    public createTheme(): string {
        return this.createXmlPart(officeThemeFactory.getTemplate());
    }

    public createWorkbook(): string {
        return this.createXmlPart(workbookFactory.getTemplate(this.sheetNames));
    }

    public createWorkbookRels(): string {
        const rs = relationshipsFactory.getTemplate([{
            Id: 'rId1',
            Type: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet',
            Target: 'worksheets/sheet1.xml'
        }, {
            Id: 'rId2',
            Type: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme',
            Target: 'theme/theme1.xml'
        }, {
            Id: 'rId3',
            Type: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles',
            Target: 'styles.xml'
        },{
            Id: 'rId4',
            Type: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings',
            Target: 'sharedStrings.xml'
        }]);

        return this.createXmlPart(rs);
    }

    public createWorksheet(worksheets: ExcelWorksheet[]): string {
        return this.createXmlPart(worksheetFactory.getTemplate(worksheets[0]));
    }
}