Package Exports
- json2xl
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (json2xl) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Json2xl
Exports JSON data to Excel along with Styles, Formatting and Formulas
This Library depends on [excel4node](https://www.npmjs.com/package/excel4node)Installation
npm install json2xlSample
A app.js script is provided in the code. Running this will output a message as : "Successfully Excel file generated in path - uploads/1443512953422.xlsx" where the filename is Current Unix Timestamp which can be changed accordinglyRun Command
node app.jsNote
I am using [rekuire](https://www.npmjs.com/package/rekuire) npm package instead of [require](https://www.npmjs.com/package/require) just to not mess up with paths and its configuration. So dont get confuseUsage
global.rekuire = require("rekuire");
var express = rekuire("express");
var app = express();
var json2xl = rekuire('json2xl');
var port = 8000;
app.use(express.static(__dirname + '/public'));
app.listen(port, function(err, res){
if(err){
throw err;
}
else{
port = process.env.port || port;
console.log("application running in port " + port);
}
});
app.get('/json2xl', function (req, res) {
var filepath = "uploads/"
var fileName = Date.now() + '.xlsx';
var wbOpts = {
jszip:{
compression:'DEFLATE'
}
};
var wsOpts = {
margins:{
left : .75,
right : .75,
top : 1.0,
bottom : 1.0,
footer : .5,
header : .5
},
printOptions:{
centerHorizontal : true,
centerVertical : false
},
view:{
zoom : 100
},
outline:{
summaryBelow : true
},
fitToPage:{
fitToHeight: 100,
orientation: 'landscape',
},
}
var data = {
"worksheets" : ['Page-1'],
"filepath": filepath,
"filename": fileName,
"rows" : [
[
{
"value" : "Row-1-Col-1",
"dataType": "string",
"style":[{
"color" : "red",
"backgroundColor" : "green",
"border" : ["thick", "black"]
}]
},
{
"value" : "2",
"dataType": "number",
"style":[{
"color" : "green",
"backgroundColor" : "brown",
"border" : ["thick","blue"]
}]
},
{
"value" : "3",
"dataType": "number",
"style":[{
"color" : "green",
"backgroundColor" : "red"
}]
},
{
"value" : 'B1+C1',
"dataType": "Formula",
"style":[{
"color" : "green",
"backgroundColor" : "red"
}]
},
{
"value" : "2015-03-25",
"dataType": "date",
"style":[{
"color" : "#E6E6E6",
"fontSize" : "58px",
"backgroundColor" : "black"
}]
},
],
[
{
"value" : "Row-2-Col-1",
"dataType": "string",
"style":[{
"color" : "red"
}]
},
{
"value" : "2",
"dataType": "number",
"style":[{
"color" : "green",
"backgroundColor" : "red"
}]
},
{
"value" : "3",
"dataType": "number",
"style":[{
"color" : "green",
"backgroundColor" : "red"
}]
},
{
"value" : 'B2+C2',
"dataType": "Formula",
"style":[{
"color" : "green",
"backgroundColor" : "red"
}]
},
{
"value" : ["https://www.google.co.in/", "Google"],
"dataType": "link",
"style":[{
"color" : "#E6E6E6",
"fontSize" : "58px",
"backgroundColor" : "black"
}]
},
],
],
"config" : {
"wbOpts" : wbOpts,
"wsOpts" : wsOpts,
"freezePanes" : {
"rows" : [1],
"cols" : [3]
}
}
};
json2xl.Json2XL(data, function(err, response){
res.end(response);
});
});Datatypes: (Optional)
** 1. String **
** 2. Number **
** 3. Formula **
Ex: "value" : 'B2+C2' // String
You can apply any excel formula to the value, this later gets converted to the appropriate value.
** 4. Link **
Ex: "value" : ["https://www.google.co.in/", "Google"] || ["https://www.google.co.in/"] // Array
You can send link with title as the second param or just link in the array
** 5. Date **
All the datatypes are optional. If nothing is defined "String" dataType is considered
CSS Styles: (Optional)
1. Color
2. BackgroundColor
3. FontSize"color" & "backgroundColor" can be either in hexadecimal or color names : #F00 or Red "fontSize" should be in pixels : 11px
Default CSS Styles
1. Pattern: "Solid"
2. Color: "#000" or "Black"
3. BackgroundColor: none;
4. FontSize: 10px
5. FontFamily: "Arial"
6. FontWeight: "Normal"
7. Border: "none"
Ex: "border" : ["thin", "black"]
i. thick or thin // Thin is preferred
ii. border color### Configurations "config" : { "wbOpts" : wbOpts, "wsOpts" : wsOpts, "freezePanes" : { "rows" : [1], "cols" : [3] } }
Workbook Settings (Optional)
var wbOpts = {
jszip:{
compression:'DEFLATE'
}
};
This enables deflate compression mode for excel as provided by excel4node package. Worksheet Settings (Optional)
var wsOpts = {
margins:{
left : .75,
right : .75,
top : 1.0,
bottom : 1.0,
footer : .5,
header : .5
},
printOptions:{
centerHorizontal : true,
centerVertical : false
},
view:{
zoom : 100
},
outline:{
summaryBelow : true
},
fitToPage:{
fitToHeight: 100,
orientation: 'landscape',
}
}
Worksheet settings such as print, outlines and margins, etc. You can refer the excel4node doc for more information.
Freezepanes (Optional)
"freezePanes" : {
"rows" : [1], // Array of rows
"cols" : [3] // Array of columns
}
The above code freezes row:1 and column: 3
Data Configurations (Optional)
"worksheets" : ['Test'],
"filepath": "/exceluploads/",
"filename": 'default_template_' + Date.now() + '.xlsx';
"rows": [['Row1_Col1','Row1_Col2',"Row1_Col3"]] **Worksheet: ** Is an array of arguments, but at present it supports only 1 worksheet
**Filepath: ** By default it gets stored in /exceluploads/ directory which is relative path to the project folder. Even if it doesnt exist. It creates, if it fails, please check with project folder permissions
**Filename: ** By default it creates file with 'default_template_'+Date.now()+'.xlsx'
**Rows: ** By default it creates single row with 3 column values
Minimal Configuration
app.get('/json2xlmin', function (req, res) {
var data = {};
json2xl.Json2XL(data, function(err, response){
res.end(response);
});
});Output
{
"status":"success",
"file":"./exceluploads/default_template_1443873516091.xlsx"
}