![\"NPM](\"https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg\"){kind=icon}
\n \n\n \n ![\"NPM](\"https://img.shields.io/npm/dt/pdfmake-to-excel\")
\n \n\n \n ![\"NPM](\"https://img.shields.io/badge/GitHub-100000?&logo=github&logoColor=white\"){kind=icon}
\n \n\n \n ![](\"https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee\"){kind=icon}
\n \n\n \n \n \n\n \n
\n Excel generation from Pdfmake tables\n Made by Patrick \n
\n\n# Main Purpose\n\nThe purpose of this package was to easily generate an Excel file from the [Pdfmake library](http://pdfmake.org/#/).\nTherefore, by providing the payload used to generate PDFs using pdfmake, you should be able to get an Excel file,\nwithout malformed cells or incorrectly structured cols and rows.\n\nHere is the documentation to build pdfmake payloads: [PDFMake Playground](http://pdfmake.org/playground.html)\n\n**This library don't require pdfmake.**\n\nHere is what this library brings:\n\n- Merge rows and cols\n- Sheet protection by password\n- Front-end excel download\n- Server-side excel download by streaming\n\n## ❯ Installation\n\nInstall pdfmake-to-excel with npm\n\n```bash\n npm install pdfmake-to-excel\n```\n\n## ❯ Usage/Examples\n\nImport the ExcelConverter class from pdfmake-to-excel, instanciate it with the name of your excel file and your pdfmake\ntable content definition object, then call the downloadExcel() method.\n\nPass the following arguments to the constructor\n\n- The Excel filename\n- The PDFMake table content definition object\n- An optional configuration object including\n * A sheet protection password\n * A default Options Excel configuration\n\n```javascript\nimport {ExcelConverter} from 'pdfmake-to-excel';\n\nfunction downloadFile() {\n const exporter = new ExcelConverter(\n 'Export test',\n contentDefinition,\n {\n protection: 'p@ssw0rd',\n defaultOptions: {defaultColWidth: 20}\n }\n );\n exporter.downloadExcel();\n}\n```\n\n## ❯ Content Definition Object Format\n\nHere is the documentation to build pdfmake payloads: [PDFMake Playground](http://pdfmake.org/playground.html). Here is\nhow you should format your table content definition object\n\n```json\n{\n \"title\": \"Title displayed on your Excel file\", //OPTIONAL\n \"logo\": \"base64 of your image here\" //OPTIONAL\n \"data\": [\n [ // LINE 01\n {\n \"text\": \"Cell 01\", // CELL 01 spanned accross 2 rows\n \"rowSpan\": 2\n },\n {\n \"text\": \"Cell 02\", // CELL 02 Spanned accross 2 cells\n \"colSpan\": 2\n },\n {\n \"text\": \"\"\n }\n ],\n [ // Empty line from the first line rowSpan\n {\n \"text\": \"\" // Empty cell from the first line rowSpan\n }\n ]\n ]\n}\n```\n\n## ❯ Multiple Sheets\n\nTo generate an Excel file with multiple sheets and a table on each sheet, all you have to do is to provide the\nExcelConverter Class with a content definition object where the data attribute is an array of sheets, each sheets being\nan object with the name (sheetName property) and the table content definition's \"data\" (See content definition object\nformat) property (sheetData property)\n\n```javascript\nconst exporter = new ExcelConverter(\n 'File_name',\n {\n data: [\n {sheetName: 'Sheet_name 01', sheetData: contentDefinitionData1},\n {sheetName: 'Sheet_name 02', sheetData: contentDefinitionData2},\n {sheetName: 'Sheet_name 03', sheetData: contentDefinitionData3},\n ]\n }\n);\n```\n\n## ❯ Streaming\n\nIn case you want to export your Excel file server-side, pdfmake-to-excel provides the getStream() method which takes in\nan optionnal argument which is your response as the first argument.\n\n- When the response argument is provided, the excel file is created and directly piped to your response.\n- When the response argument is not provided, you'll get the stream itself. Up to you to pipe it wherever you want\n\n## ❯ Example Using NestJS\n\n```javascript\n@Get('/export-excel-file')\nasync exportReportExcel(@Res() response:Response):Promise < any > {\n const exporter = new ExcelConverter('FileTest', contentDefinition);\n\n // Automatic pipe to response\n await exporter.getStream(response);\n\n\n // Get the stream\n const stream = await exporter.getStream();\n\n // Then pipe it if you want\n stream.pipe(response);\n}\n```\n\n## ❯ Example Using AdonisJS\n\n```javascript\nconst ExportService = use('App/Services/ExportService');\n\nconst {ExcelConverter} = require('pdfmake-to-excel')\n\nclass ExportController{\n async exportAction({request, response}){\n\n const executor = ExportService(request.all());\n const excelConverter = new ExcelConverter('test-filename.png', await executor.getData());\n\n response.implicitEnd = false;\n response.header('Content-Type', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')\n response.header('Content-Transfer-Encoding', 'binary');\n response.header('Content-Disposition', `attachment; filename=\"fichier.xlsx\"`)\n\n excelConverter.getStream().pipe(response.response);\n }\n}\nmodule.exports = ExportController;\n```","readmeFilename":"README.md"}