pptxgenjs-testwebpack

v1.9.9-webpack

Published

3 years ago

JavaScript framework that creates PowerPoint (pptx) presentations

Downloads

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

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

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

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 or scheme color constant. 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
Node can also be used to stream a powerpoint file - simply pass a filename that begins with "http"
Output type can be specified by passing an optional JSZip output type

// Example A: File will be saved to the local working directory (`__dirname`)
pptx.save('Node_Demo');

// Example B: Inline callback function
pptx.save('Node_Demo', function(filename){ console.log('Created: '+filename); });

// Example C: Predefined callback function
pptx.save('Node_Demo', saveCallback);

// Example D: Use a filename of "http" or "https" to receive the powerpoint binary data in your callback
// (Used for streaming the presentation file via http.  See the `nodejs-demo.js` file for a working example.)
pptx.save('http', streamCallback);

// Example E: Save using various JSZip output types: ['arraybuffer', 'base64', 'binarystring', 'blob', 'nodebuffer', 'uint8array']
pptx.save('jszip', saveCallback, 'base64');

Saving Multiple Presentations

Client-Side:

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');

Node.js:

Multiple presentations are a bit more complicated in Node - see Issue #83

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, pptx.charts.DOUGHNUT

Multi-Type Charts

Chart types can be any one of pptx.charts, although pptx.charts.AREA, pptx.charts.BAR, and pptx.charts.LINE will give the best results.
There should be at least two chart-types. There should always be two value axes and category axes.
Multi Charts have a different function signature than standard. There are two parameters:
chartTypes: Array of objects, each with type, data, and options objects.
options: Standard options as used with single charts. Can include axes options.
Columns makes the most sense in general. Line charts cannot be rotated to match up with horizontal bars (a PowerPoint limitation).
Can optionally have a secondary value axis.
If there is secondary value axis, a secondary category axis is required in order to render, but currently always uses the primary labels. It is recommended to use catAxisHidden: true on the secondary category axis.
Standard options are used, and the chart-type-options are mixed in to each.

// Syntax
slide.addChart({MULTI_TYPES_AND_DATA}, {OPTIONS_AND_AXES});

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%'} places object in 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 colors | 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' } | | holeSize | number | percent | 50 | doughnut hole size | 1-100. Ex: { holeSize:50 } | | invertedColors| array | | | data colors for negative numbers | array of hex color codes. Ex: ['0088CC','FFCC00'] | | legendFontSize| number | points | 10 | legend font size | 1-256. Ex: { legendFontSize: 13 }| | legendPos | string | | r | chart legend position | b (bottom), tr (top-right), l (left), r (right), t (top) | | layout | object | | | positioning plot within chart area | object with x, y, w and h props, all in range 0-1 (proportionally related to the chart size). Ex: {x: 0, y: 0, w: 1, h: 1} fully expands chart within the plot area | | showDataTable | boolean | | false | show Data Table under the chart | true or false (Not available for Pie/Doughnut charts) | | showDataTableKeys | boolean | | true | show Data Table Keys (color blocks) | true or false (Not available for Pie/Doughnut charts) | | showDataTableHorzBorder | boolean | | true | show Data Table horizontal borders | true or false (Not available for Pie/Doughnut charts) | | showDataTableVertBorder | boolean | | true | show Data Table vertical borders | true or false (Not available for Pie/Doughnut charts) | | showDataTableOutline | boolean | | true | show Data Table table outline | true or false (Not available for Pie/Doughnut charts) | | 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' } | | titleAlign | string | | center | chart title text align | left center or right Ex: { titleAlign:'left' } | | 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 } | | titlePos | object | | | title position | object with x and y values. Ex: { titlePos:{x: 0, y: 10} } | | titleRotate | integer | degrees | | title rotation degrees | 0-360. Ex: { titleRotate:45 } |

Chart Axis Options

| Option | Type | Unit | Default | Description | Possible Values | | :--------------------- | :------ | :------ | :----------- | :---------------------------- | :----------------------------------------------- | | axisLineColor | string | | 000000 | cat/val axis line color | hex color code. Ex: { axisLineColor:'0088CC' } | | catAxisBaseTimeUnit | string | | | category-axis base time unit | days months or years | | catAxisHidden | boolean | | false | hide category-axis | true or false | | 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 | integer | points | 18 | category-axis font size | 1-256. Ex: { titleFontSize:12 } | | catAxisLabelFrequency| integer | | | PPT "Interval Between Labels" | 1-n. Ex: { catAxisLabelFrequency: 2 } | | catAxisLineShow | boolean | | true | show/hide category-axis line | true or false | | catAxisMajorTimeUnit | string | | | category-axis major time unit | days months or years | | catAxisMinorTimeUnit | string | | | category-axis minor time unit | days months or years | | catAxisMajorUnit | integer | | | category-axis major unit | Positive integer. Ex: { catAxisMajorUnit:12 } | | catAxisMinorUnit | integer | | | category-axis minor unit | Positive integer. Ex: { catAxisMinorUnit:1 } | | catAxisOrientation | string | | minMax | category-axis orientation | maxMin (high->low) or minMax (low->high) | | catAxisTitle | string | | Axis Title | axis title | a string. Ex: { catAxisTitle:'Regions' } | | catAxisTitleColor | string | | 000000 | title color | hex color code. Ex: { catAxisTitleColor:'0088CC' } | | catAxisTitleFontFace | string | | Arial | font face | font name. Ex: { catAxisTitleFontFace:'Arial' } | | catAxisTitleFontSize | integer | points | | font size | 1-256. Ex: { catAxisTitleFontSize:12 } | | catAxisTitleRotate | integer | degrees | | title rotation degrees | 0-360. Ex: { catAxisTitleRotate:45 } | | catGridLine | object | | none | category grid line style | object with properties size (pt), color and style ('solid', 'dash' or 'dot') or 'none' to hide | | showCatAxisTitle | boolean | | false | show category (vert) title | true or false. Ex:{ showCatAxisTitle:true } | | showValAxisTitle | boolean | | false | show values (horiz) title | true or false. Ex:{ showValAxisTitle:true } | | valAxisHidden | boolean | | false | hide value-axis | true or false | | 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 | integer | points | 18 | value-axis font size | 1-256. Ex: { titleFontSize:12 } | | valAxisLabelFormatCode | string | | General | value-axis number format | format string. Ex: { axisLabelFormatCode:'#,##0' } MicroSoft Number Format Codes | | valAxisLineShow | boolean | | true | show/hide value-axis line | true or false | | valAxisMajorUnit | number | | 1.0 | value-axis tick steps | Float or whole number. Ex: { majorUnit:0.2 } | | valAxisMaxVal | number | | | value-axis maximum value | 1-N. Ex: { valAxisMaxVal:125 } | | valAxisMinVal | number | | | value-axis minimum value | 1-N. Ex: { valAxisMinVal: -10 } | | valAxisOrientation | string | | minMax | value-axis orientation | maxMin (high->low) or minMax (low->high) | | valAxisTitle | string | | Axis Title | axis title | a string. Ex: { valAxisTitle:'Sales (USD)' } | | valAxisTitleColor | string | | 000000 | title color | hex color code. Ex: { valAxisTitleColor:'0088CC' } | | valAxisTitleFontFace | string | | Arial | font face | font name. Ex: { valAxisTitleFontFace:'Arial' } | | valAxisTitleFontSize | number | points | | font size | 1-256. Ex: { valAxisTitleFontSize:12 } | | valAxisTitleRotate | integer | degrees | | title rotation degrees | 0-360. Ex: { valAxisTitleRotate:45 } | | valGridLine | object | | | value grid line style | object with properties size (pt), color and style ('solid', 'dash' or 'dot') or 'none' to hide |

Chart Data Options

| Option | :--------------------- | barDir | barGapWidthPct | barGrouping | dataBorder | dataLabelColor | dataLabelFormatCode | dataLabelFontFace | dataLabelFontSize | dataLabelPosition | dataNoEffects | gridLineColor | lineDataSymbol | lineDataSymbolSize | lineDataSymbolLineSize | lineDataSymbolLineColor| | shadow | lineSize | valueBarColors | Type | Unit | Default | Description | Possible Values | | :------ | :------ | :-------- | :------------------------- | :----------------------------------------- | | string | | col | bar direction | (Bar Chart) bar (horizontal) or col (vertical). Ex: {barDir:'bar'} | | number | percent | 150 | width % between bar groups | (Bar Chart) 0-999. Ex: { barGapWidthPct:50 } | | string | |clustered| bar grouping | (Bar Chart) clustered or stacked or percentStacked. | | object | | | data border | object with pt and color values. Ex: border:{pt:'1', color:'f1f1f1'} | | string | | 000000 | data label color | hex color code. Ex: { dataLabelColor:'0088CC' } | | string | | | format to show data value | format string. Ex: { dataLabelFormatCode:'#,##0' } MicroSoft Number Format Codes | | string | | Arial | value-axis font face | font name. Ex: { titleFontFace:'Arial' } | | number | points | 18 | value-axis font size | 1-256. Ex: { titleFontSize:12 } | | string | | bestFit | data label position | bestFit,b,ctr,inBase,inEnd,l,outEnd,r,t | | boolean | | false | whether to omit effects on data | (Doughnut/Pie Charts) true or false | | string | | 000000 | grid line color | hex color code. Ex: { gridLineColor:'0088CC' } | | string | | circle | symbol used on line marker | circle,dash,diamond,dot,none,square,triangle | | number | points | 6 | size of line data symbol | 1-256. Ex: { lineDataSymbolSize:12 } | | number | points | 0.75 | size of data symbol outline | 1-256. Ex: { lineDataSymbolLineSize:12 } | number | points | 0.75 | size of data symbol outline | 1-256. Ex: { lineDataSymbolLineSize:12 } | | object | | | data element shadow options | 'none' or shadow options | | number | points | 2 | thickness of data line (0 is no line) | 0-256. Ex: { lineSize: 1 } | | boolean | | false | forces chartColors on multi-data-series | true or false |

Chart Element Shadow Options

| Option | Type | Unit | Default | Description | Possible Values | | :----------- | :------ | :------ | :-------- | :------------------ | :----------------------------------------- | | type | string | | outer | shadow type | outer or inner. Ex: { type:'outer' } | | angle | number | degrees | 90 | shadow angle | 0-359. Ex: { angle:90 } | | blur | number | points | 3 | blur size | 1-256. Ex: { blur:3 } | | color | string | | 000000 | shadow color | hex color code. Ex: { color:'0088CC' } | | offset | number | points | 1.8 | offset size | 1-256. Ex: { offset:2 } | | opacity | number | percent | 0.35 | opacity | 0-1. Ex: { opacity:0.35 } |

Chart Multi-Type Options

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 } );

// Chart Type: Multi-Type
// NOTE: use the same labels for all types
var labels = ['Q1', 'Q2', 'Q3', 'Q4', 'OT'];
var chartTypes = [
  {
    type: pptx.charts.BAR,
    data: [{
      name: 'Projected',
      labels: labels,
      values: [17, 26, 53, 10, 4]
    }],
    options: { barDir: 'col' }
  },
  {
    type: pptx.charts.LINE,
    data: [{
      name: 'Current',
      labels: labels,
      values: [5, 3, 2, 4, 7]
    }],
    options: {
      // NOTE: both are required, when using a secondary axis:
      secondaryValAxis: true,
      secondaryCatAxis: true
    }
  }
];
var multiOpts = {
  x:1.0, y:1.0, w:6, h:6,
  showLegend: false,
  valAxisMaxVal: 100,
  valAxisMinVal: 0,
  valAxisMajorUnit: 20,
  valAxes:[
    {
      showValAxisTitle: true,
      valAxisTitle: 'Primary Value Axis'
    },
    {
      showValAxisTitle: true,
      valAxisTitle: 'Secondary Value Axis',
      valAxisMajorUnit: 1,
      valAxisMaxVal: 10,
      valAxisMinVal: 1,
      valGridLine: 'none'
    }
  ],
  catAxes: [{ catAxisTitle: 'Primary Category Axis' }, { catAxisHidden: true }]
};

slide.addChart(chartTypes, multiOpts);

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 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 or scheme color constant. Ex: { color:'0088CC' } | | fill | string | | | fill/bkgd color | hex color code or scheme color constant. 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 | | lang | string | | en-US | language setting | Ex: { lang:'zh-TW' } (Set this when using non-English fonts like Chinese) | | lineSpacing| number | points | | line spacing points | 1-256. Ex: { lineSpacing:28 } | | 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' } | | subscript | boolean | | false | subscript text | true or false | | superscript| boolean | | false | superscript text | true or false | | 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 or scheme color constant. 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. Ex: {autoPage: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 or scheme color constant. Ex: {color:'0088CC'} | | colspan | integer | | | column span | 2-n. Ex: {colspan:2} | | fill | string | | | fill/bkgd color | hex color code or scheme color constant. Ex: {color:'0088CC'} | | font_face | string | | | font face | Ex: {font_face:'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
Cell borders can be removed (aka: borderless table) by passing a 'none' (Ex: border:'none')

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 or scheme color constant. Ex: {color:'0088CC'} | | fill | object | | | fill/bkgd color | object with type, color, alpha (opt). 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 or scheme color constant. 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) | | sizing | object | | | transforms image | See Image Sizing |

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');

Image Sizing

The sizing option provides cropping and scaling an image to a specified area. The property expects an object with the following structure:

Particular type values behave as follows:

contain works as CSS property background-size — shrinks the image (ratio preserved) to the area given by w and h so that the image is completely visible. If the area's ratio differs from the image ratio, an empty space will surround the image.
cover works as CSS property background-size — shrinks the image (ratio preserved) to the area given by w and h so that the area is completely filled. If the area's ratio differs from the image ratio, the image is centered to the area and cropped.
crop cuts off a part specified by image-related coordinates x, y and size w, h.

NOTES:

If you specify an area size larger than the image for the contain and cover type, then the image will be stretched, not shrunken.
In case of the crop option, if the specified area reaches out of the image, then the covered empty space will be a part of the image.
When the sizing property is used, its w and h values represent the effective image size. For example, in the following snippet, width and height of the image will both equal to 2 inches and its top-left corner will be located at [1 inch, 1 inch]:

slide.addImage({
  path: '...',
  w: 4,
  h: 3,
  x: 1,
  y: 1,
  sizing: {
    type: 'contain',
    w: 2,
    h: 2
  }
});

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

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 Slide Master Layouts via objects that can then be used to provide branding functionality.

Slide Masters are created by calling the defineSlideMaster() method along with an options object (same style used in Slides). Once defined, you can pass the Master title to addNewSlide() and that Slide will use the Layout previously defined. See the demo under /examples for several working examples.

The defined Masters become first-class Layouts in the exported PowerPoint presentation and can be changed via View > Slide Master and will affect the Slides created using that layout.

Slide Master Object Options

| Option | Type | Unit | Default | Description | Possible Values | | :------------ | :------ | :----- | :------- | :----------- | :-------------------- | | bkgd | string | | ffffff | color | hex color code or scheme color constant. 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:chart,image,line,rect or text. Example | | title | string | | | Layout title/name | some title |

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

Slide Master Examples

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

pptx.defineSlideMaster({
  title: 'MASTER_SLIDE',
  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', o

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

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

Saving Multiple Presentations

Presentations: Adding Objects

Adding Charts

Chart Types

Multi-Type Charts

Chart Size/Formatting Options

Chart Axis Options

Chart Data Options

Chart Element Shadow Options

Chart Multi-Type 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

Image Sizing

Adding Media (Audio/Video/YouTube)

Media Options

Media Examples

Master Slides and Corporate Branding

Slide Masters

Slide Master Object Options

Slide Master Examples