officegen-2 #

This module were built up-on the original module officegen which weren't published by me.
In this module, I've support the feature of exporting chart ( pie, bar, column ).
But the code is a bit hacky, that's why I've published this module separately.
Used it for your own risks.

This module can generate Office Open XML files (the files been created by Microsoft Office 2007 and later).
This module is not depend on any framework so you can use it for any kind of node.js application, even not
web based. Also the output is a stream and not a file. This module should work on any environment that supporting
node.js including Linux, OS-X and Windows and it's not depending on any output tool.

This module is a Javascript porting of my 'DuckWriteC++' library which doing the same in C++.

Announcement: ##

OpenOffice document generation support will be added in the future.
Please refer to the roadmap section for information on what will be added in the next versions.

Contents: ##

- Features
- Installation
- Public API
- Examples
- FAQ
- Hackers Wonderland
- Support
- History
- Roadmap
- License
- Credit

Features: ##

- Generating Microsoft PowerPoint document (.pptx file):
- Create PowerPoint document with one or more slides.
- Support both PPT and PPS.
- Add text blocks.
- Add images.
- Can declare fonts, alignment, colors and background.
- Support shapes: Ellipse, Rectangle, Line, Arrows, etc.
- Support hidden slides.
- Support
- Generating Microsoft Word document (.docx file):
- Create Word document.
- You can add one or more paragraphs to the document and you can set the fonts, colors, alignment, etc.
- You can add images.
- Generating Microsoft Excel document (.xlsx file):
- Create Excel document with one or more sheets. Supporting cells of type both number and string.

Installation: ##

via Git:

``bash
$ git clone git://github.com/vtloc/officegen.git
`

via npm:

`bash
$ npm install officegen-2
`

This module is depending on:

- archiver
- setimmediate
- fast-image-size
- underscore
- xmlbuilder



Public API: ##

$3

`js
var officegen = require('officegen');
`

There are two ways to use the officegen function:

`js
officegen ( '' );

officegen ({
'type': ''
// More options here (if needed)
});
`

Generating PowerPoint 2007 object:

`js
var pptx = officegen ( 'pptx' );
`

Generating Word 2007 object:

`js
var docx = officegen ( 'docx' );
`

Generating Excel 2007 object:

`js
var xlsx = officegen ( 'xlsx' );
`

General events of officegen:

- 'finalize' - been called after finishing to create the document.
- 'error' - been called on error.

Event examples:

`js
pptx.on ( 'finalize', function ( written ) {
console.log ( 'Finish to create a PowerPoint file.\nTotal bytes created: ' + written + '\n' );
});

pptx.on ( 'error', function ( err ) {
console.log ( err );
});
`

Another way to register either 'finalize' or 'error' events:

`js
var pptx = officegen ({
'type': 'pptx', // or 'xlsx', etc
'onend': function ( written ) {
console.log ( 'Finish to create a PowerPoint file.\nTotal bytes created: ' + written + '\n' );
},
'onerr': function ( err ) {
console.log ( err );
}
});
`

If you are preferring to use callbacks instead of events you can pass your callbacks to the generate method
(see below).

Now you should fill the object with data (we'll see below) and then you should call generate with
an output stream to create the output Office document.

Example with pptx:

`js
var out = fs.createWriteStream ( 'out.pptx' );

pptx.generate ( out );
`

Passing callbacks to generate:

`js
var out = fs.createWriteStream ( 'out.pptx' );

pptx.generate ( out, {
'finalize': function ( written ) {
console.log ( 'Finish to create a PowerPoint file.\nTotal bytes created: ' + written + '\n' );
},
'error': function ( err ) {
console.log ( err );
}
});
`

Generating HTTP stream (no file been created):

`js
var http = require("http");
var officegen = require('officegen');

http.createServer ( function ( request, response ) {
response.writeHead ( 200, {
"Content-Type": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
'Content-disposition': 'attachment; filename=surprise.pptx'
});

var pptx = officegen ( 'pptx' );

pptx.on ( 'finalize', function ( written ) {
// ...
});

pptx.on ( 'error', function ( err ) {
// ...
});

// ... (fill pptx with data)

pptx.generate ( response );
}).listen ( 3000 );
`

$3

#### MS-Office document properties (for all document types): ###

The default Author of all the documents been created by officegen is 'officegen'. If you want to put anything else please
use the 'creator' option when calling the officegen function:

`js
var pptx = officegen ({
'type': 'pptx', // or 'xlsx', etc
'creator': ''
});
`

Change the document title (pptx,ppsx,docx):

`js
var pptx = officegen ({
'type': 'pptx',
'title': '