PptxGenJS

JavaScript library that produces PowerPoint (pptx) presentations

Quickly and easily create PowerPoint presentations with a few simple JavaScript commands in client web browsers or Node desktop apps.

Main Features

Widely Supported: Creates and downloads presentations on all current web browsers (Chrome, Edge, Firefox, etc.) and IE11
Full Featured: Slides can include Charts, Images, Media, Shapes, Tables and Text (plus Master Slides/Templates)
Easy To Use: Entire PowerPoint presentations can be created in a few lines of code
Modern: Pure JavaScript solution - everything necessary to create PowerPoint PPT exports is included

Additional Features

Use the unique Table-to-Slides feature to copy an HTML table into 1 or more Slides with a single command

Table of Contents (generated with DocToc)

Live Demo
Installation
- Client-Side
- Node.js
Presentations: Usage and Options
Presentations: Adding Objects
Master Slides and Corporate Branding
Table-to-Slides Feature
Full PowerPoint Shape Library
Performance Considerations
- Pre-Encode Large Images
Building with Webpack/Typescript
Issues / Suggestions
Need Help?
Development Roadmap
Unimplemented Features
Special Thanks
Support Us
License

Live Demo

Use JavaScript to Create a PowerPoint presentation with your web browser right now:
https://gitbrent.github.io/PptxGenJS

Installation

Client-Side

Include Local Scripts

<script lang="javascript" src="PptxGenJS/libs/jquery.min.js"></script>
<script lang="javascript" src="PptxGenJS/libs/jszip.min.js"></script>
<script lang="javascript" src="PptxGenJS/dist/pptxgen.js"></script>

Include Bundled Script

<script lang="javascript" src="PptxGenJS/dist/pptxgen.bundle.js"></script>

Install With Bower

bower install pptxgen

Node.js

PptxGenJS NPM Homepage

npm install pptxgenjs

var pptx = require("pptxgenjs");

Presentations: Usage and Options

PptxGenJS PowerPoint presentations are created via JavaScript by following 4 basic steps:

Create a new Presentation
Add a Slide
Add one or more objects (Tables, Shapes, Images, Text and Media) to the Slide
Save the Presentation

var pptx = new PptxGenJS();
var slide = pptx.addNewSlide();
slide.addText('Hello World!', { x:1.5, y:1.5, font_size:18, color:'363636' });
pptx.save('Sample Presentation');

That's really all there is to it!

Creating a Presentation

A Presentation is a single .pptx file. When creating more than one Presentation, declare the pptx again to start with a new, empty Presentation.

Client Browser:

var pptx = new PptxGenJS();

Node.js:

var pptx = require("pptxgenjs");

Presentation Properties

There are several optional properties that can be set:

pptx.setAuthor('Brent Ely');
pptx.setCompany('S.T.A.R. Laboratories');
pptx.setRevision('15');
pptx.setSubject('Annual Report');
pptx.setTitle('PptxGenJS Sample Presentation');

Presentation Layouts

Setting the Layout (applies to all Slides in the Presentation):

pptx.setLayout('LAYOUT_WIDE');

Presentation Layout Options

Layout Name	Default	Layout Slide Size
`LAYOUT_16x9`	Yes	10 x 5.625 inches
`LAYOUT_16x10`	No	10 x 6.25 inches
`LAYOUT_4x3`	No	10 x 7.5 inches
`LAYOUT_WIDE`	No	13.3 x 7.5 inches
`LAYOUT_USER`	No	user defined - see below (inches)

Custom user defined Layout sizes are supported - just supply a name and the size in inches.

Defining a new Layout using an object will also set this new size as the current Presentation Layout

// Defines and sets this new layout for the Presentation
pptx.setLayout({ name:'A3', width:16.5, height:11.7 });

Presentation Text Direction

Right-to-Left (RTL) text is supported. Simply set the RTL mode at the Presentation-level.

pptx.setRTL(true);

Adding a Slide

Syntax:

var slide = pptx.addNewSlide();

Slide Formatting

slide.bkgd  = 'F1F1F1';
slide.color = '696969';

Slide Formatting Options

Option	Type	Unit	Default	Description	Possible Values
`bkgd`	string		`FFFFFF`	background color	hex color code.
`color`	string		`000000`	default text color	hex color code.

Applying Master Slides / Branding

// Create a new Slide that will inherit properties from a pre-defined master page (margins, logos, text, background, etc.)
var slide1 = pptx.addNewSlide( pptx.masters.TITLE_SLIDE );

// The background color can be overridden on a per-slide basis:
var slide2 = pptx.addNewSlide( pptx.masters.TITLE_SLIDE, {bkgd:'FFFCCC'} );

Adding Slide Numbers

slide.slideNumber({ x:1.0, y:'90%' });
// Slide Numbers can be styled:
slide.slideNumber({ x:1.0, y:'90%', fontFace:'Courier', fontSize:32, color:'CF0101' });

Slide Number Options

Option	Type	Unit	Default	Description	Possible Values
`x`	number	inches	`0.3`	horizontal location	0-n OR 'n%'. (Ex: `{x:'10%'}` places number 10% from left edge)
`y`	number	inches	`90%`	vertical location	0-n OR 'n%'. (Ex: `{y:'90%'}` places number 90% down the Slide)
`color`	string			text color	hex color code. Ex: `{color:'0088CC'}`
`fontFace`	string			font face	any available font. Ex: `{fontFace:Arial}`
`fontSize`	number	points		font size	8-256. Ex: `{fontSize:12}`

Slide Return Value

The Slide object returns a reference to itself, so calls can be chained.

Example:

slide
.addImage({ path:'images/logo1.png', x:1, y:2, w:3, h:3 })
.addImage({ path:'images/logo2.jpg', x:5, y:3, w:3, h:3 })
.addImage({ path:'images/logo3.png', x:9, y:4, w:3, h:3 });

Saving a Presentation

Presentations require nothing more than passing a filename to save(). Node.js users have more options available examples of which can be found below.

Client Browser

Simply provide a filename

pptx.save('Demo-Media');

Node.js

Node can accept a callback function that will return the filename once the save is complete

// A: File will be saved to the local working directory (`__dirname`)
pptx.save( 'Node_Demo' );
// B: Inline callback function
pptx.save( 'Node_Demo', function(filename){ console.log('Created: '+filename); } );
// C: Predefined callback function
pptx.save( 'Node_Demo', saveCallback );

Saving multiple Presentations:

In order to generate a new, unique Presentation just create a new instance of the library then add objects and save as normal.

var pptx = require("pptxgenjs");
pptx.addNewSlide().addText('Presentation 1', {x:1, y:1});
pptx.save('PptxGenJS-Presentation-1');

// Create a new instance ("Reset")
pptx = require("pptxgenjs");
pptx.addNewSlide().addText('Presentation 2', {x:1, y:1});
pptx.save('PptxGenJS-Presentation-2');

Presentations: Adding Objects

Objects on the Slide are ordered from back-to-front based upon the order they were added.

For example, if you add an Image, then a Shape, then a Textbox: the Textbox will be in front of the Shape, which is in front of the Image.

Adding Charts

// Syntax
slide.addChart({TYPE}, {DATA}, {OPTIONS});

Chart Types

Chart type can be any one of pptx.charts
Currently: pptx.charts.AREA, pptx.charts.BAR, pptx.charts.LINE, pptx.charts.PIE

Chart Size/Formatting Options

Option	Type	Unit	Default	Description	Possible Values
`x`	number	inches	`1.0`	horizontal location	0-n OR 'n%'. (Ex: `{x:'50%'}` will place object in the middle of the Slide)
`y`	number	inches	`1.0`	vertical location	0-n OR 'n%'.
`w`	number	inches	`50%`	width	0-n OR 'n%'. (Ex: `{w:'50%'}` will make object 50% width of the Slide)
`h`	number	inches	`50%`	height	0-n OR 'n%'.
`border`	object			chart border	object with `pt` and `color` values. Ex: `border:{pt:'1', color:'f1f1f1'}`
`chartColors`	array			data color	array of hex color codes. Ex: `['0088CC','FFCC00']`
`chartColorsOpacity`	number	percent	`100`	data color opacity percent	1-100. Ex: `{ chartColorsOpacity:50 }`
`fill`	string			fill/background color	hex color code. Ex: `{ fill:'0088CC' }`
`legendPos`	string		`r`	chart legend position	`b` (bottom), `tr` (top-right), `l` (left), `r` (right), `t` (top)
`showLabel`	boolean		`false`	show data labels	`true` or `false`
`showLegend`	boolean		`false`	show chart legend	`true` or `false`
`showPercent`	boolean		`false`	show data percent	`true` or `false`
`showTitle`	boolean		`false`	show chart title	`true` or `false`
`showValue`	boolean		`false`	show data values	`true` or `false`
`title`	string			chart title	a string. Ex: `{ title:'Sales by Region' }`
`titleColor`	string		`000000`	title color	hex color code. Ex: `{ titleColor:'0088CC' }`
`titleFontFace`	string		`Arial`	font face	font name. Ex: `{ titleFontFace:'Arial' }`
`titleFontSize`	number	points	`18`	font size	1-256. Ex: `{ titleFontSize:12 }`

Chart Axis Options

Option	Type	Unit	Default	Description	Possible Values
`catAxisLabelColor`	string		`000000`	category-axis color	hex color code. Ex: `{ catAxisLabelColor:'0088CC' }`
`catAxisLabelFontFace`	string		`Arial`	category-axis font face	font name. Ex: `{ titleFontFace:'Arial' }`
`catAxisLabelFontSize`	number	points	`18`	category-axis font size	1-256. Ex: `{ titleFontSize:12 }`
`catAxisOrientation`	string		`minMax`	category-axis orientation	`maxMin` (high->low) or `minMax` (low->high)
`valAxisLabelColor`	string		`000000`	value-axis color	hex color code. Ex: `{ valAxisLabelColor:'0088CC' }`
`valAxisLabelFontFace`	string		`Arial`	value-axis font face	font name. Ex: `{ titleFontFace:'Arial' }`
`valAxisLabelFontSize`	number	points	`18`	value-axis font size	1-256. Ex: `{ titleFontSize:12 }`
`valAxisMaxVal`	number			maximum value for Value Axis	1-N. Ex: `{ valAxisMaxVal:125 }`
`valAxisOrientation`	string		`minMax`	value-axis orientation	`maxMin` (high->low) or `minMax` (low->high)

Chart Data Options

Option	Type	Unit	Default	Description	Possible Values
`barDir`	string		`col`	bar direction	(Bar Chart) `bar` (horizontal) or `col` (vertical). Ex: `{barDir:'bar'}`
`barGapWidthPct`	number	percent	`150`	width % between bar groups	(Bar Chart) 0-999. Ex: `{ barGapWidthPct:50 }`
`barGrouping`	string		`clustered`	bar grouping	(Bar Chart) `clustered` or `stacked` or `percentStacked`.
`dataBorder`	object			data border	object with `pt` and `color` values. Ex: `border:{pt:'1', color:'f1f1f1'}`
`dataLabelColor`	string		`000000`	value-axis color	hex color code. Ex: `{ dataLabelColor:'0088CC' }`
`dataLabelFormatCode`	string			format to show data value	format string. Ex: `{ dataLabelFormatCode:'#,##0' }` MicroSoft Number Format Codes
`dataLabelFontFace`	string		`Arial`	value-axis font face	font name. Ex: `{ titleFontFace:'Arial' }`
`dataLabelFontSize`	number	points	`18`	value-axis font size	1-256. Ex: `{ titleFontSize:12 }`
`dataLabelPosition`	string		`bestFit`	data label position	`bestFit`,`b`,`ctr`,`inBase`,`inEnd`,`l`,`outEnd`,`r`,`t`
`lineDataSymbol`	string		`circle`	symbol used on line marker	`circle`,`dash`,`diamond`,`dot`,`none`,`square`,`triangle`
`lineDataSymbolSize`	number	points	`6`	size of line data symbol	1-256. Ex: `{ lineDataSymbolSize:12 }`

Chart Examples

var pptx = new PptxGenJS();
pptx.setLayout('LAYOUT_WIDE');

var slide = pptx.addNewSlide();

// Chart Type: BAR
var dataChartBar = [
  {
    name  : 'Region 1',
    labels: ['May', 'June', 'July', 'August'],
    values: [26, 53, 100, 75]
  },
  {
    name  : 'Region 2',
    labels: ['May', 'June', 'July', 'August'],
    values: [43.5, 70.3, 90.1, 80.05]
  }
];
slide.addChart( pptx.charts.BAR, dataChartBar, { x:1.0, y:1.0, w:12, h:6 } );

// Chart Type: AREA
// Chart Type: LINE
var dataChartAreaLine = [
  {
    name  : 'Actual Sales',
    labels: ['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec'],
    values: [1500, 4600, 5156, 3167, 8510, 8009, 6006, 7855, 12102, 12789, 10123, 15121]
  },
  {
    name  : 'Projected Sales',
    labels: ['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec'],
    values: [1000, 2600, 3456, 4567, 5010, 6009, 7006, 8855, 9102, 10789, 11123, 12121]
  }
];
slide.addChart( pptx.charts.AREA, dataChartAreaLine, { x:1.0, y:1.0, w:12, h:6 } );
slide.addChart( pptx.charts.LINE, dataChartAreaLine, { x:1.0, y:1.0, w:12, h:6 } );

// Chart Type: PIE
var dataChartPie = [
  { name:'Location', labels:['DE','GB','MX','JP','IN','US'], values:[35,40,85,88,99,101] }
];
slide.addChart( pptx.charts.PIE, dataChartPie, { x:1.0, y:1.0, w:6, h:6 } );

pptx.save('Demo-Chart');

Adding Text

// Syntax
slide.addText('TEXT', {OPTIONS});
slide.addText('Line 1\nLine 2', {OPTIONS});
slide.addText([ {text:'TEXT', options:{OPTIONS}} ]);

Text Options

Option	Type	Unit	Default	Description	Possible Values
`x`	number	inches	`1.0`	horizontal location	0-n OR 'n%'. (Ex: `{x:'50%'}` will place object in the middle of the Slide)
`y`	number	inches	`1.0`	vertical location	0-n OR 'n%'.
`w`	number	inches		width	0-n OR 'n%'. (Ex: `{w:'50%'}` will make object 50% width of the Slide)
`h`	number	inches		height	0-n OR 'n%'.
`align`	string		`left`	alignment	`left` or `center` or `right`
`autoFit`	boolean		`false`	"Fit to Shape"	`true` or `false`
`bold`	boolean		`false`	bold text	`true` or `false`
`breakLine`	boolean		`false`	appends a line break	`true` or `false` (only applies when used in text object options) Ex: `{text:'hi', options:{breakLine:true}}`
`bullet`	boolean		`false`	bulleted text	`true` or `false`
`bullet`	object			bullet options (number type or choose any unicode char)	object with `type` or `code`. Ex: `bullet:{type:'number'}`. Ex: `bullet:{code:'2605'}`
`color`	string			text color	hex color code. Ex: `{ color:'0088CC' }`
`fill`	string			fill/bkgd color	hex color code. Ex: `{ color:'0088CC' }`
`font_face`	string			font face	Ex: 'Arial'
`font_size`	number	points		font size	1-256. Ex: `{ font_size:12 }`
`hyperlink`	string			add hyperlink	object with `url` and optionally `tooltip`. Ex: `{ hyperlink:{url:'https://github.com'} }`
`indentLevel`	number	level	`0`	bullet indent level	1-32. Ex: `{ indentLevel:1 }`
`inset`	number	inches		inset/padding	1-256. Ex: `{ inset:1.25 }`
`isTextBox`	boolean		`false`	PPT "Textbox"	`true` or `false`
`italic`	boolean		`false`	italic text	`true` or `false`
`margin`	number	points		margin	0-99 (ProTip: use the same value from CSS `padding`)
`rectRadius`	number	inches		rounding radius	rounding radius for `ROUNDED_RECTANGLE` text shapes
`rtlMode`	boolean		`false`	enable Right-to-Left mode	`true` or `false`
`shadow`	object			text shadow options	see options below. Ex: `shadow:{ type:'outer' }`
`underline`	boolean		`false`	underline text	`true` or `false`
`valign`	string			vertical alignment	`top` or `middle` or `bottom`

Text Shadow Options

Option	Type	Unit	Default	Description	Possible Values
`type`	string		outer	shadow type	`outer` or `inner`
`angle`	number	degrees		shadow angle	0-359. Ex: `{ angle:180 }`
`blur`	number	points		blur size	1-256. Ex: `{ blur:3 }`
`color`	string			text color	hex color code. Ex: `{ color:'0088CC' }`
`offset`	number	points		offset size	1-256. Ex: `{ offset:8 }`
`opacity`	number	percent		opacity	0-1. Ex: `opacity:0.75`

Text Examples

var pptx = new PptxGenJS();
var slide = pptx.addNewSlide();

// EX: Dynamic location using percentages
slide.addText('^ (50%/50%)', {x:'50%', y:'50%'});

// EX: Basic formatting
slide.addText('Hello',  { x:0.5, y:0.7, w:3, color:'0000FF', font_size:64 });
slide.addText('World!', { x:2.7, y:1.0, w:5, color:'DDDD00', font_size:90 });

// EX: More formatting options
slide.addText(
    'Arial, 32pt, green, bold, underline, 0 inset',
    { x:0.5, y:5.0, w:'90%', margin:0.5, font_face:'Arial', font_size:32, color:'00CC00', bold:true, underline:true, isTextBox:true }
);

// EX: Format some text
slide.addText('Hello World!', { x:2, y:4, font_face:'Arial', font_size:42, color:'00CC00', bold:true, italic:true, underline:true } );

// EX: Multiline Text / Line Breaks - use "\n" to create line breaks inside text strings
slide.addText('Line 1\nLine 2\nLine 3', { x:2, y:3, color:'DDDD00', font_size:90 });

// EX: Format individual words or lines by passing an array of text objects with `text` and `options`
slide.addText(
    [
        { text:'word-level', options:{ font_size:36, color:'99ABCC', align:'r', breakLine:true } },
        { text:'formatting', options:{ font_size:48, color:'FFFF00', align:'c' } }
    ],
    { x:0.5, y:4.1, w:8.5, h:2.0, fill:'F1F1F1' }
);

// EX: Bullets
slide.addText('Regular, black circle bullet', { x:8.0, y:1.4, w:'30%', h:0.5, bullet:true });
// Use line-break character to bullet multiple lines
slide.addText('Line 1\nLine 2\nLine 3', { x:8.0, y:2.4, w:'30%', h:1, fill:'F2F2F2', bullet:{type:'number'} });
// Bullets can also be applied on a per-line level
slide.addText(
    [
        { text:'I have a star bullet'    , options:{bullet:{code:'2605'}, color:'CC0000'} },
        { text:'I have a triangle bullet', options:{bullet:{code:'25BA'}, color:'00CD00'} },
        { text:'no bullets on this line' , options:{font_size:12} },
        { text:'I have a normal bullet'  , options:{bullet:true, color:'0000AB'} }
    ],
    { x:8.0, y:5.0, w:'30%', h:1.4, color:'ABABAB', margin:1 }
);

// EX: Hyperlinks
slide.addText(
    [{
        text: 'PptxGenJS Project',
        options: { hyperlink:{ url:'https://github.com/gitbrent/pptxgenjs', tooltip:'Visit Homepage' } }
    }],
    { x:1.0, y:1.0, w:5, h:1 }
);

// EX: Drop/Outer Shadow
slide.addText(
    'Outer Shadow',
    {
        x:0.5, y:6.0, font_size:36, color:'0088CC',
        shadow: {type:'outer', color:'696969', blur:3, offset:10, angle:45}
    }
);

// EX: Formatting can be applied at the word/line level
// Provide an array of text objects with the formatting options for that `text` string value
// Line-breaks work as well
slide.addText(
    [
        { text:'word-level\nformatting', options:{ font_size:36, font_face:'Courier New', color:'99ABCC', align:'r', breakLine:true } },
        { text:'...in the same textbox', options:{ font_size:48, font_face:'Arial', color:'FFFF00', align:'c' } }
    ],
    { x:0.5, y:4.1, w:8.5, h:2.0, margin:0.1, fill:'232323' }
);

pptx.save('Demo-Text');

Adding Tables

Syntax:

slide.addTable( [rows] );
slide.addTable( [rows], {any Layout/Formatting OPTIONS} );

Table Layout Options

Option	Type	Unit	Default	Description	Possible Values
`x`	number	inches	`1.0`	horizontal location	0-n OR 'n%'. (Ex: `{x:'50%'}` will place object in the middle of the Slide)
`y`	number	inches	`1.0`	vertical location	0-n OR 'n%'.
`w`	number	inches		width	0-n OR 'n%'. (Ex: `{w:'50%'}` will make object 50% width of the Slide)
`h`	number	inches		height	0-n OR 'n%'.
`colW`	integer	inches		width for every column	Ex: Width for every column in table (uniform) `2.0`
`colW`	array	inches		column widths in order	Ex: Width for each of 5 columns `[1.0, 2.0, 2.5, 1.5, 1.0]`
`rowH`	integer	inches		height for every row	Ex: Height for every row in table (uniform) `2.0`
`rowH`	array	inches		row heights in order	Ex: Height for each of 5 rows `[1.0, 2.0, 2.5, 1.5, 1.0]`

Table Auto-Paging Options

Option	Type	Default	Description	Possible Values
`autoPage`	boolean	`true`	auto-page table	`true` or `false`
`lineWeight`	float	0	line weight value	-1.0 to 1.0. Ex: `{lineWeight:0.5}`
`newPageStartY`	object		starting `y` value for tables on new Slides	0-n OR 'n%'. Ex:`{newPageStartY:0.5}`

Table Auto-Paging Notes

Tables will auto-page by default and the table on new Slides will use the current Slide's top margin value as the starting point for y. Tables will retain their existing x, w, and colW values as they are continued onto subsequent Slides.

autoPage: allows the auto-paging functionality (as table rows overflow the Slide, new Slides will be added) to be disabled.
lineWeight: adjusts the calculated height of lines. If too much empty space is left under each table, then increase lineWeight value. Conversely, if the tables are overflowing the bottom of the Slides, then reduce the lineWeight value. Also helpful when using some fonts that do not have the usual golden ratio.
newPageStartY: provides the ability to specify where new tables will be placed on new Slides. For example, you may place a table halfway down a Slide, but you wouldn't that to be the starting location for subsequent tables. Use this option to ensure there is no wasted space and to guarantee a professional look.

Table Formatting Options

Option	Type	Unit	Default	Description	Possible Values
`align`	string		`left`	alignment	`left` or `center` or `right` (or `l` `c` `r`)
`bold`	boolean		`false`	bold text	`true` or `false`
`border`	object			cell border	object with `pt` and `color` values. Ex: `{pt:'1', color:'f1f1f1'}`
`border`	array			cell border	array of objects with `pt` and `color` values in TRBL order.
`color`	string			text color	hex color code. Ex: `{color:'0088CC'}`
`colspan`	integer			column span	2-n. Ex: `{colspan:2}`
`fill`	string			fill/bkgd color	hex color code. Ex: `{color:'0088CC'}`
`font_face`	string			font face	Ex: 'Arial'
`font_size`	number	points		font size	1-256. Ex: `{font_size:12}`
`italic`	boolean		`false`	italic text	`true` or `false`
`margin`	number	points		margin	0-99 (ProTip: use the same value from CSS `padding`)
`margin`	array	points		margin	array of integer values in TRBL order. Ex: `margin:[5,10,5,10]`
`rowspan`	integer			row span	2-n. Ex: `{rowspan:2}`
`underline`	boolean		`false`	underline text	`true` or `false`
`valign`	string			vertical alignment	`top` or `middle` or `bottom` (or `t` `m` `b`)

Table Formatting Notes

Formatting Options passed to slide.addTable() apply to every cell in the table
You can selectively override formatting at a cell-level providing any Formatting Option in the cell options

Table Cell Formatting

Table cells can be either a plain text string or an object with text and options properties
When using an object, any of the formatting options above can be passed in options and will apply to that cell only

Bullets and word-level formatting are supported inside table cells. Passing an array of objects with text/options values as the text value allows fine-grained control over the text inside cells.

Available formatting options are here: Text Options
See below for examples or view the examples/pptxgenjs-demo.html page for lots more

Table Cell Formatting Examples

// TABLE 1: Cell-level Formatting
var rows = [];
// Row One: cells will be formatted according to any options provided to `addTable()`
rows.push( ['First', 'Second', 'Third'] );
// Row Two: set/override formatting for each cell
rows.push([
    { text:'1st', options:{color:'ff0000'} },
    { text:'2nd', options:{color:'00ff00'} },
    { text:'3rd', options:{color:'0000ff'} }
]);
slide.addTable( rows, { x:0.5, y:1.0, w:9.0, color:'363636' } );

// TABLE 2: Using word-level formatting inside cells
// NOTE: An array of text/options objects provides fine-grained control over formatting
var arrObjText = [
    { text:'Red ',   options:{color:'FF0000'} },
    { text:'Green ', options:{color:'00FF00'} },
    { text:'Blue',   options:{color:'0000FF'} }
];
// EX A: Pass an array of text objects to `addText()`
slide.addText( arrObjText, { x:0.5, y:2.75, w:9, h:2, margin:0.1, fill:'232323' } );

// EX B: Pass the same objects as a cell's `text` value
var arrTabRows = [
    [
        { text:'Cell 1 A',  options:{font_face:'Arial'  } },
        { text:'Cell 1 B',  options:{font_face:'Courier'} },
        { text: arrObjText, options:{fill:'232323'}       }
    ]
];
slide.addTable( arrTabRows, { x:0.5, y:5, w:9, h:2, colW:[1.5,1.5,6] } );

Table Examples

var pptx = new PptxGenJS();
var slide = pptx.addNewSlide();
slide.addText('Demo-03: Table', { x:0.5, y:0.25, font_size:18, font_face:'Arial', color:'0088CC' });

// TABLE 1: Single-row table
// --------
var rows = [ 'Cell 1', 'Cell 2', 'Cell 3' ];
var tabOpts = { x:0.5, y:1.0, w:9.0, fill:'F7F7F7', font_size:14, color:'363636' };
slide.addTable( rows, tabOpts );

// TABLE 2: Multi-row table (each rows array element is an array of cells)
// --------
var rows = [
    ['A1', 'B1', 'C1'],
    ['A2', 'B2', 'C2']
];
var tabOpts = { x:0.5, y:2.0, w:9.0, fill:'F7F7F7', font_size:18, color:'6f9fc9' };
slide.addTable( rows, tabOpts );

// TABLE 3: Formatting at a cell level - use this to selectively override table's cell options
// --------
var rows = [
    [
        { text:'Top Lft', options:{ valign:'t', align:'l', font_face:'Arial'   } },
        { text:'Top Ctr', options:{ valign:'t', align:'c', font_face:'Verdana' } },
        { text:'Top Rgt', options:{ valign:'t', align:'r', font_face:'Courier' } }
    ],
];
var tabOpts = { x:0.5, y:4.5, w:9.0, rowH:0.6, fill:'F7F7F7', font_size:18, color:'6f9fc9', valign:'m'} };
slide.addTable( rows, tabOpts );

// Multiline Text / Line Breaks - use either "\r" or "\n"
slide.addTable( ['Line 1\nLine 2\nLine 3'], { x:2, y:3, w:4 });

pptx.save('Demo-Tables');

Adding Shapes

Syntax (no text):

slide.addShape({SHAPE}, {OPTIONS});

Syntax (with text):

slide.addText("some string", {SHAPE, OPTIONS});

Check the pptxgen.shapes.js file for a complete list of the hundreds of PowerPoint shapes available.

Shape Options

Option	Type	Unit	Default	Description	Possible Values
`x`	number	inches	`1.0`	horizontal location	0-n OR 'n%'. (Ex: `{x:'50%'}` will place object in the middle of the Slide)
`y`	number	inches	`1.0`	vertical location	0-n OR 'n%'.
`w`	number	inches		width	0-n OR 'n%'. (Ex: `{w:'50%'}` will make object 50% width of the Slide)
`h`	number	inches		height	0-n OR 'n%'.
`align`	string		`left`	alignment	`left` or `center` or `right`
`fill`	string			fill/bkgd color	hex color code. Ex: `{color:'0088CC'}`
`fill`	object			fill/bkgd color	object with `type`, `color` and optional `alpha` keys. Ex: `fill:{type:'solid', color:'0088CC', alpha:25}`
`flipH`	boolean			flip Horizontal	`true` or `false`
`flipV`	boolean			flip Vertical	`true` or `false`
`line`	string			border line color	hex color code. Ex: `{line:'0088CC'}`
`line_dash`	string		`solid`	border line dash style	`dash`, `dashDot`, `lgDash`, `lgDashDot`, `lgDashDotDot`, `solid`, `sysDash` or `sysDot`
`line_head`	string			border line ending	`arrow`, `diamond`, `oval`, `stealth`, `triangle` or `none`
`line_size`	number	points		border line size	1-256. Ex: {line_size:4}
`line_tail`	string			border line heading	`arrow`, `diamond`, `oval`, `stealth`, `triangle` or `none`
`rectRadius`	number	inches		rounding radius	rounding radius for `ROUNDED_RECTANGLE` text shapes
`rotate`	integer	degrees		rotation degrees	0-360. Ex: `{rotate:180}`

Shape Examples

var pptx = new PptxGenJS();
pptx.setLayout('LAYOUT_WIDE');

var slide = pptx.addNewSlide();

// LINE
slide.addShape(pptx.shapes.LINE,      { x:4.15, y:4.40, w:5, h:0, line:'FF0000', line_size:1 });
slide.addShape(pptx.shapes.LINE,      { x:4.15, y:4.80, w:5, h:0, line:'FF0000', line_size:2, line_head:'triangle' });
slide.addShape(pptx.shapes.LINE,      { x:4.15, y:5.20, w:5, h:0, line:'FF0000', line_size:3, line_tail:'triangle' });
slide.addShape(pptx.shapes.LINE,      { x:4.15, y:5.60, w:5, h:0, line:'FF0000', line_size:4, line_head:'triangle', line_tail:'triangle' });
// DIAGONAL LINE
slide.addShape(pptx.shapes.LINE,      { x:0, y:0, w:5.0, h:0, line:'FF0000', rotate:45 });
// RECTANGLE
slide.addShape(pptx.shapes.RECTANGLE, { x:0.50, y:0.75, w:5, h:3, fill:'FF0000' });
// OVAL
slide.addShape(pptx.shapes.OVAL,      { x:4.15, y:0.75, w:5, h:2, fill:{ type:'solid', color:'0088CC', alpha:25 } });

// Adding text to Shapes:
slide.addText('RIGHT-TRIANGLE', { shape:pptx.shapes.RIGHT_TRIANGLE, align:'c', x:0.40, y:4.3, w:6, h:3, fill:'0088CC', line:'000000', line_size:3 });
slide.addText('RIGHT-TRIANGLE', { shape:pptx.shapes.RIGHT_TRIANGLE, align:'c', x:7.00, y:4.3, w:6, h:3, fill:'0088CC', line:'000000', flipH:true });

pptx.save('Demo-Shapes');

Adding Images

Syntax:

slide.addImage({OPTIONS});

Animated GIFs can be included in Presentations in one of two ways:

Using Node.js: use either data or path options (Node can encode any image into base64)
Client Browsers: pre-encode the gif and add it using the data option (encoding images into GIFs is beyond any current browser)

Image Options

Option	Type	Unit	Default	Description	Possible Values
`x`	number	inches	`1.0`	horizontal location	0-n
`y`	number	inches	`1.0`	vertical location	0-n
`w`	number	inches	`1.0`	width	0-n
`h`	number	inches	`1.0`	height	0-n
`data`	string			image data (base64)	base64-encoded image string. (either `data` or `path` is required)
`hyperlink`	string			add hyperlink	object with `url` and optionally `tooltip`. Ex: `{ hyperlink:{url:'https://github.com'} }`
`path`	string			image path	Same as used in an (img src="") tag. (either `data` or `path` is required)

NOTES

SVG images are not currently supported in PowerPoint or PowerPoint Online (even when encoded into base64). PptxGenJS does properly encode and include SVG images, so they will begin showing once Microsoft adds support for this image type.
Using path to add remote images (images from a different server) is not currently supported.

Deprecation Warning
Old positional parameters (e.g.: slide.addImage('images/chart.png', 1, 1, 6, 3)) are now deprecated as of 1.1.0

Image Examples

var pptx = new PptxGenJS();
var slide = pptx.addNewSlide();

// Image by path
slide.addImage({ path:'images/chart_world_peace_near.png', x:1.0, y:1.0, w:8.0, h:4.0 });
// Image by data (base64-encoding)
slide.addImage({ data:'image/png;base64,iVtDafDrBF[...]=', x:3.0, y:5.0, w:6.0, h:3.0 });

// NOTE: Slide API calls return the same slide, so you can chain calls:
slide.addImage({ path:'images/cc_license_comp_chart.png', x:6.6, y:0.75, w:6.30, h:3.70 })
     .addImage({ path:'images/cc_logo.jpg',               x:0.5, y:3.50, w:5.00, h:3.70 })
     .addImage({ path:'images/cc_symbols_trans.png',      x:6.6, y:4.80, w:6.30, h:2.30 });

// Image with Hyperlink
slide.addImage({
  x:1.0, y:1.0, w:8.0, h:4.0,
  hyperlink:{ url:'https://github.com/gitbrent/pptxgenjs', tooltip:'Visit Homepage' },
  path:'images/chart_world_peace_near.png',
});

pptx.save('Demo-Images');

Adding Media (Audio/Video/YouTube)

Syntax:

slide.addMedia({OPTIONS});

Both Video (mpg, mov, mp4, m4v, etc.) and Audio (mp3, wav, etc.) are supported (list of supported formats)

Using Node.js: use either data or path options (Node can encode any media into base64)
Client Browsers: pre-encode the media and add it using the data option (encoding video/audio is beyond any current browser)

Online video (YouTube embeds, etc.) is supported in both client browser and in Node.js

Media Options

Option	Type	Unit	Default	Description	Possible Values
`x`	number	inches	`1.0`	horizontal location	0-n
`y`	number	inches	`1.0`	vertical location	0-n
`w`	number	inches	`1.0`	width	0-n
`h`	number	inches	`1.0`	height	0-n
`data`	string			media data (base64)	base64-encoded string
`path`	string			media path	relative path to media file
`link`	string			online url/link	link to online video. Ex: `link:'https://www.youtube.com/embed/blahBlah'`
`type`	string			media type	media type: `audio` or `video` (reqs: `data` or `path`) or `online` (reqs:`link`)

Media Examples

var pptx = new PptxGenJS();
var slide = pptx.addNewSlide();

// Media by path (Node.js only)
slide.addMedia({ type:'audio', path:'../media/sample.mp3', x:1.0, y:1.0, w:3.0, h:0.5 });
// Media by data (client browser or Node.js)
slide.addMedia({ type:'audio', data:'audio/mp3;base64,iVtDafDrBF[...]=', x:3.0, y:1.0, w:6.0, h:3.0 });
// Online by link (client browser or Node.js)
slide.addMedia({ type:'online', link:'https://www.youtube.com/embed/Dph6ynRVyUc', x:1.0, y:4.0, w:8.0, h:4.5 });

pptx.save('Demo-Media');

Master Slides and Corporate Branding

Slide Masters

Generating sample slides like those shown above is great for demonstrating library features, but the reality is most of us will be required to produce presentations that have a certain design or corporate branding.

PptxGenJS allows you to define Master Slides via objects that can then be used to provide branding functionality.

Slide Masters are defined using the same object style used in Slides. Add these objects as a variable to a file that is included in the script src tags on your page, then reference them by name in your code.
E.g.: <script lang="javascript" src="pptxgenjs.masters.js"></script>

Slide Master Examples

pptxgenjs.masters.js contents:

var gObjPptxMasters = {
  MASTER_SLIDE: {
    title:   'Slide Master',
    bkgd:    'FFFFFF',
    objects: [
      { 'line':  { x: 3.5, y:1.00, w:6.00, line:'0088CC', line_size:5 } },
      { 'rect':  { x: 0.0, y:5.30, w:'100%', h:0.75, fill:'F1F1F1' } },
      { 'text':  { text:'Status Report', options:{ x:3.0, y:5.30, w:5.5, h:0.75 } } },
      { 'image': { x:11.3, y:6.40, w:1.67, h:0.75, path:'images/logo.png' } }
    ],
    slideNumber: { x:0.3, y:'90%' }
  },
  TITLE_SLIDE: {
    title:   'I am the Title Slide',
    bkgd:    { data:'image/png;base64,R0lGONlhotPQBMAPyoAPosR[...]+0pEZbEhAAOw==' },
    objects: [
      { 'text':  { text:'Greetings!', options:{ x:0.0, y:0.9, w:'100%', h:1, font_face:'Arial', color:'FFFFFF', font_size:60, align:'c' } } },
      { 'image': { x:11.3, y:6.40, w:1.67, h:0.75, path:'images/logo.png' } }
    ]
  }
};

Every object added to the global master slide variable gObjPptxMasters can then be referenced by their key names that you created (e.g.: "TITLE_SLIDE").

TIP: Pre-encode your images (base64) and add the string as the optional data key/val (see the TITLE_SLIDE.images object above)

var pptx = new PptxGenJS();

var slide1 = pptx.addNewSlide( pptx.masters.TITLE_SLIDE );
slide1.addText('How To Create PowerPoint Presentations with JavaScript', { x:0.5, y:0.7, font_size:18 });
// NOTE: Base master slide properties can be overridden on a selective basis:
// Here we can set a new background color or image on-the-fly
var slide2 = pptx.addNewSlide( pptx.masters.MASTER_SLIDE, { bkgd:'0088CC' } );
var slide3 = pptx.addNewSlide( pptx.masters.MASTER_SLIDE, { bkgd:{ path:'images/title_bkgd.jpg' } } );
var slide4 = pptx.addNewSlide( pptx.masters.MASTER_SLIDE, { bkgd:{ data:'image/png;base64,tFfInmP[...]=' } } );

pptx.save();

Slide Master Object Options

Option	Type	Unit	Default	Description	Possible Values
`bkgd`	string		`ffffff`	color	hex color code. Ex: `{ bkgd:'0088CC' }`
`bkgd`	object			image	object with path OR data. Ex: `{path:'img/bkgd.png'}` OR `{data:'image/png;base64,iVBORwTwB[...]='}`
`slideNumber`	object			Show slide numbers	ex: `{ x:1.0, y:'50%' }` `x` and `y` can be either inches or percent
`margin`	number	inches	`1.0`	Slide margins	0.0 through Slide.width
`margin`	array			Slide margins	array of numbers in TRBL order. Ex: `[0.5, 0.75, 0.5, 0.75]`
`objects`	array			Objects for Slide	object with type and options. Type:`image`,`line`,`rect` or `text`. Example
`title`	string			Slide title	some title

Sample Slide Master File

A sample masters file is included in the distribution folder and contain a couple of different slides to get you started.
Location: PptxGenJS/dist/pptxgen.masters.js

Table-to-Slides Feature

Syntax:

slide.addSlidesForTable(htmlElementID);
slide.addSlidesForTable(htmlElementID, {OPTIONS});

Any variety of HTML tables can be turned into a series of slides (auto-paging) by providing the table's ID.

Reproduces an HTML table - background colors, borders, fonts, padding, etc.
Slide margins are based on either the Master Slide provided or options

NOTE: Nested tables are not supported in PowerPoint, so only the string contents of a single level deep table cell will be reproduced

Table-to-Slides Options

Option	Type	Unit	Description	Possible Values
`x`	number	inches	horizontal location	0-256. Table will be placed here on each Slide
`y`	number	inches	vertical location	0-256. Table will be placed here on each Slide
`w`	number	inches	width	0-256. Default is (100% - Slide margins)
`h`	number	inches	height	0-256. Default is (100% - Slide margins)
`master`	string		master slide name	Any pre-defined Master Slide. EX: `{ master:pptx.masters.TITLE_SLIDE }`
`addHeaderToEach`	boolean		add table headers to each slide	EX: `addHeaderToEach:true`
`addImage`	string		add an image to each slide	Use the established syntax. EX: `{ addImage:{ path:"images/logo.png", x:10, y:0.5, w:1.2, h:0.75 } }`
`addShape`	string		add a shape to each slide	Use the established syntax.
`addTable`	string		add a table to each slide	Use the established syntax.
`addText`	string		add text to each slide	Use the established syntax.

Table-to-Slides HTML Options

A minimum column width can be specified by adding a data-pptx-min-width attribute to any given <th> tag.

Example:

<table id="tabAutoPaging" class="tabCool">
  <thead>
    <tr>
      <th data-pptx-min-width="0.6" style="width: 5%">Row</th>
      <th data-pptx-min-width="0.8" style="width:10%">Last Name</th>
      <th data-pptx-min-width="0.8" style="width:10%">First Name</th>
      <th                           style="width:75%">Description</th>
    </tr>
  </thead>
  <tbody></tbody>
</table>

Table-to-Slides Notes

Default x, y and margin value is 0.5 inches, the table will take up all remaining space by default (h:100%, w:100%)
Your Master Slides should already have defined margins, so a Master Slide name is the only option you'll need most of the time

Table-to-Slides Examples

// Pass table element ID to addSlidesForTable function to produce 1-N slides
pptx.addSlidesForTable( 'myHtmlTableID' );

// Optionally, include a Master Slide name for pre-defined margins, background, logo, etc.
pptx.addSlidesForTable( 'myHtmlTableID', { master:pptx.masters.MASTER_SLIDE } );

// Optionally, add images/shapes/text/tables to each Slide
pptx.addSlidesForTable( 'myHtmlTableID', { addText:{ text:"Dynamic Title", options:{x:1, y:0.5, color:'0088CC'} } } );
pptx.addSlidesForTable( 'myHtmlTableID', { addImage:{ path:"images/logo.png", x:10, y:0.5, w:1.2, h:0.75 } } );

Creative Solutions

Design a Master Slide that already contains: slide layout, margins, logos, etc., then you can produce professional looking Presentations with a single line of code which can be embedded into a link or a button:

Add a button to a webpage that will create a Presentation using whatever table data is present:

<input type="button" value="Export to PPTX"
 onclick="{ var pptx = new PptxGenJS(); pptx.addSlidesForTable('tableId',{ master:pptx.masters.MASTER_SLIDE }); pptx.save(); }">

SharePoint Integration

Placing a button like this into a WebPart is a great way to add "Export to PowerPoint" functionality to SharePoint. (You'd also need to add the 4 <script> includes in the same or another WebPart)

Full PowerPoint Shape Library

If you are planning on creating Shapes (basically anything other than Text, Tables or Rectangles), then you'll want to include the pptxgen.shapes.js library.

The shapes file contains a complete PowerPoint Shape object array thanks to the officegen project.

<script lang="javascript" src="PptxGenJS/dist/pptxgen.shapes.js"></script>

Performance Considerations

It takes CPU time to read and encode images! The more images you include and the larger they are, the more time will be consumed. The time needed to read/encode images can be completely eliminated by pre-encoding any images (see below).

Pre-Encode Large Images

Pre-encode images into a base64 string (eg: 'image/png;base64,iVBORw[...]=') for use as the data option value. This will both reduce dependencies (who needs another image asset to keep track of?) and provide a performance boost (no time will need to be consumed reading and encoding the image).

Building with Webpack/Typescript

Add this to your webpack config to avoid a module resolution error:
node: { fs: "empty" }

See Issue #72 for more information

Issues / Suggestions

Please file issues or suggestions on the issues page on github, or even better, submit a pull request. Feedback is always welcome!

When reporting issues, please include a code snippet or a link demonstrating the problem. Here is a small jsFiddle that is already configured and uses the latest PptxGenJS code.

Need Help?

Sometimes implementing a new library can be a difficult task and the slightest mistake will keep something from working. We've all been there!

If you are having issues getting a presentation to generate, check out the demos in the examples directory. There are demos for both nodejs and client-browsers that contain working examples of every available library feature.

Use a pre-configured jsFiddle to test with: PptxGenJS Fiddle
Use Ask Question on StackOverflow - be sure to tag it with "PptxGenJS"

Development Roadmap

Version 2.0 will be released in late 2017 and will drop support for IE11 as we move to adopt more JavaScript ES6 features and remove many instances of jQuery utility functions.

Unimplemented Features

The PptxgenJS library is not designed to replicate all the functionality of PowerPoint, meaning several features are not on the development roadmap.

These include:

Animations
Cross-Slide Links
Importing Existing Templates
Outlines
SmartArt

Special Thanks

Officegen Project - For the Shape definitions and XML code
Dzmitry Dulko - For getting the project published on NPM
Everyone who has submitted an Issue or Pull Request. :-)

Support Us

Do you like this library and find it useful? Add a link to the PptxGenJS project on your blog, website or social media.

Thanks to everyone who supports this project! <3

License

MIT

michalsnik / pptxgenjs Goto Github PK

pptxgenjs's Introduction

PptxGenJS

JavaScript library that produces PowerPoint (pptx) presentations

Main Features

Additional Features

Live Demo

Installation

Client-Side

Include Local Scripts

Include Bundled Script

Install With Bower

Node.js

Presentations: Usage and Options

Creating a Presentation

Presentation Properties

Presentation Layouts

Presentation Layout Options

Presentation Text Direction

Adding a Slide

Slide Formatting

Slide Formatting Options

Applying Master Slides / Branding

Adding Slide Numbers

Slide Number Options

Slide Return Value

Saving a Presentation

Client Browser

Node.js

Presentations: Adding Objects

Adding Charts

Chart Types

Chart Size/Formatting Options

Chart Axis Options

Chart Data Options

Chart Examples

Adding Text

Text Options

Text Shadow Options

Text Examples

Adding Tables

Table Layout Options

Table Auto-Paging Options

Table Auto-Paging Notes

Table Formatting Options

Table Formatting Notes

Table Cell Formatting

Table Cell Formatting Examples

Table Examples

Adding Shapes

Shape Options

Shape Examples

Adding Images

Image Options

Image Examples

Adding Media (Audio/Video/YouTube)

Media Options

Media Examples

Master Slides and Corporate Branding

Slide Masters

Slide Master Examples

Slide Master Object Options

Sample Slide Master File

Table-to-Slides Feature

Table-to-Slides Options

Table-to-Slides HTML Options

Table-to-Slides Notes

Table-to-Slides Examples

Creative Solutions

Full PowerPoint Shape Library

Performance Considerations

Pre-Encode Large Images

Building with Webpack/Typescript

Issues / Suggestions

Need Help?

Development Roadmap

Unimplemented Features

Special Thanks

Support Us

License