Members
(inner, constant) pdfPageGeometry :object
The available page sizes for PDF export.
Page sizes are in pixels, assuming a resolution of 96 dpi,
for each format supported by the printToPDF
function of the Electron API.
All formats are in landscape mode by default.
Type:
- object
- Source:
(inner, constant) pptxSlideGeometry :object
The available slide sizes for PPTX export.
Slide sizes are represented by aspect ratios regardless of a physical size. The export function will assume a screen height equal to 1080 pixels. The keys represent all formats supported by the Officegen PPTX API. All formats are in landscape mode by default.
Type:
- object
- Source:
(inner, constant) pptxSlideHeightPx :number
The default height of PPTX slides, in pixels.
Type:
- number
- Default Value:
- 1080
- Source:
Methods
(static) exportToPDF(presentation, htmlFileName) → {Promise}
Export a presentation to a PDF document.
Parameters:
Name | Type | Description |
---|---|---|
presentation |
module:model/Presentation.Presentation | The presentation to export. |
htmlFileName |
string | The name of the presentation HTML file. |
- Source:
Returns:
- A promise that resolves when the operation completes.
- Type
- Promise
(static) exportToPPTX(presentation, htmlFileName) → {Promise}
Export a presentation to a PPTX document.
Parameters:
Name | Type | Description |
---|---|---|
presentation |
module:model/Presentation.Presentation | The presentation to export. |
htmlFileName |
string | The name of the presentation HTML file. |
- Source:
Returns:
- A promise that resolves when the operation completes.
- Type
- Promise
(static) exportToVideo(presentation, htmlFileName) → {Promise}
Export a presentation to a video document.
Parameters:
Name | Type | Description |
---|---|---|
presentation |
module:model/Presentation.Presentation | The presentation to export. |
htmlFileName |
string | The name of the presentation HTML file. |
- Source:
Returns:
- A promise that resolves when the operation completes.
- Type
- Promise
(inner) markFrames(list, expr, value)
Parse a list of frames to include or exclude from the export.
expr ::= interval ("," interval)*
interval ::=
INT // frame number
| INT? ":" INT? // first:last
| INT? ":" INT? ":" INT? // first:second:last
In an interval:
- If
first
is omitted, it is set to 1. - If
second
is omitted, it is set tofirst + 1
. - If
last
is omitted, it is set tolist.length
.
Parameters:
Name | Type | Description |
---|---|---|
list |
Array.<boolean> | The status of each frame of the presentation. |
expr |
string | An expression that represents a list of frames. |
value |
boolean | The value to assign for each frame to mark. |
- Source:
(inner) markFramesFromLists(pres, include, exclude) → {Array.<boolean>}
Mark frames to include or exclude from export.
Parameters:
Name | Type | Description |
---|---|---|
pres |
module:model/Presentation.Presentation | The presentation to export. |
include |
string | An expression that represents a list of frames to include. |
exclude |
string | An expression that represents a list of frames to exclude. |
- Source:
Returns:
- The status of each frame in the presentation.
- Type
- Array.<boolean>
(inner) markInterval(list, first, last, step, value)
Update the status of a sequence of frame numbers to include or exclude in the export.
Parameters:
Name | Type | Description |
---|---|---|
list |
Array.<boolean> | The status of each frame of the presentation. |
first |
number | The index of the first element to update. |
last |
number | The index of the last element to update. |
step |
number | The step between elements to update. |
value |
boolean | The value to assign at each index. |
- Source:
(inner) nextFrameIndex(list, index) → {number}
Get the index of a frame to include in the export, after a given index.
Parameters:
Name | Type | Description |
---|---|---|
list |
Array.<boolean> | The status of each frame of the presentation. |
index |
number | The index of the current frame. |
- Source:
Returns:
- The index of the next frame that is marked for inclusion.
- Type
- number
(inner) zeroPadded(value, digits) → {string}
Pad an integer value with zeros.
Parameters:
Name | Type | Description |
---|---|---|
value |
number | A value to pad. |
digits |
number | The number of digits in the result. |
- Source:
Returns:
- A zero-padded representation of the given value.
- Type
- string