officegen Documentation

You can extend officegen by registering new document types using the baseobj.plugins.registerDocType method. This allows you to implement support for new formats (like OpenOffice or custom types) by providing a factory function that extends the base generator object.

To register a type, call registerDocType with the following arguments:

• type_code (string): The unique identifier for the new type.
• factory_function (function): A function that receives genobj, new_type, options, gen_private, and type_info to implement the document logic.
• options (object): Configuration options for the new type.
• base_type (constant): The base document category (e.g., baseobj.docType.PRESENTATION).
• display_name (string): The human-readable name of the document type.

var baseobj = require('./basicgen.js')

/**
 * Extend officegen object with some new document type support.
 *
 * @param {object} genobj The object to extend.
 * @param {string} new_type The type of object to create.
 * @param {object} options The object's options.
 * @param {object} gen_private Access to the internals of this object.
 * @param {object} type_info Additional information about this type.
 */
function makeSomeType(genobj, new_type, options, gen_private, type_info) {
  // ...
}

baseobj.plugins.registerDocType(
  'mytype', // The type code string.
  makeSomeType,
  {},
  baseobj.docType.PRESENTATION,
  'My Document'
)

Use officegen('docx') to create a Word object. You can create paragraphs using createP(), add text with specific styles (color, font, alignment, bold, underline, highlight), add images, and insert page breaks. The generate() method streams the output to a writable stream.

const officegen = require('officegen')
const fs = require('fs')

// Create an empty Word object:
let docx = officegen('docx')

// Create a new paragraph with styled text:
let pObj = docx.createP()
pObj.addText('Simple')
pObj.addText(' with color', { color: '000088' })
pObj.addText(' and back color.', { color: '00ffff', back: '000088' })

// Add a paragraph with a hyperlink:
pObj = docx.createP()
pObj.addText('Even add ', { bold: true })
pObj.addText('external link', { link: 'https://github.com' })

// Add a page break:
docx.putPageBreak()

// Add an image:
pObj = docx.createP()
pObj.addImage('some-image.png')

// Generate the document to a file:
let out = fs.createWriteStream('example.docx')
docx.generate(out)

Use officegen('pptx') to create a PowerPoint object. You can create title slides, new slides, add text, images, and native charts. The generate() method works like a pipe, allowing you to stream the output to a file system write stream or an HTTP response stream.

const officegen = require('officegen')
const fs = require('fs')

// Create an empty PowerPoint object:
let pptx = officegen('pptx')

// Add a title slide:
let slide = pptx.makeTitleSlide('Officegen', 'Example to a PowerPoint document')

// Add a new slide with a chart:
slide = pptx.makeNewSlide()
slide.name = 'Pie Chart slide'
slide.back = 'ffff00'
slide.addChart(
  {
    title: 'My production',
    renderType: 'pie',
    data:
	[
      {
        name: 'Oil',
        labels: ['Czech Republic', 'Ireland', 'Germany', 'Australia', 'Austria', 'UK', 'Belgium'],
        values: [301, 201, 165, 139, 128,  99, 60],
        colors: ['ff0000', '00ff00', '0000ff', 'ffff00', 'ff00ff', '00ffff', '000000']
      }
    ]
  }
)

// Generate the document to a file:
let out = fs.createWriteStream('example.pptx')
pptx.generate(out)