Skip to main content

Type Alias: AutomizerParams

AutomizerParams = object

Defined in: src/types/types.ts:63

Properties​

archiveType?​

optional archiveType?: ArchiveParams

Defined in: src/types/types.ts:87

Use 'fs' if you want to extract all archive contents to disc. ArchiveParams.mode defaults to 'jszip'.

assertRelatedContents?​

optional assertRelatedContents?: boolean

Defined in: src/types/types.ts:128

Pptx-automizer can try to add any missing related content that could not be handled properly by "addElement" or "addMaster" or one of their subroutines. This probably fixes corrupted pptx files.

autoImportSlideMasters?​

optional autoImportSlideMasters?: boolean

Defined in: src/types/types.ts:115

Turn this to true if you always want to import all required slide masters. You don't need to adjust with slide.useSlideLayout, but it will have a negative impact on performance. It is highly recommended to activate autoImportSlideMasters in case your loaded templates have different sets of slideMasters & -layouts.

cleanup?​

optional cleanup?: boolean

Defined in: src/types/types.ts:137

Eventually remove all unnecessary files from archive.

cleanupPlaceholders?​

optional cleanupPlaceholders?: boolean

Defined in: src/types/types.ts:142

Remove all unused shape placeholders from slide. Set to false when you are using slide.mergeIntoSlideLayout.

compression?​

optional compression?: number

Defined in: src/types/types.ts:91

Zip compression level 0-9

continueOnError?​

optional continueOnError?: boolean

Defined in: src/types/types.ts:167

By default, a throwing modification callback or an unresolvable element selector fails the run loudly with a typed error. Set to true to restore the lenient behavior: log a warning, skip the failing modification and continue.

logger?​

optional logger?: ILogger

Defined in: src/types/types.ts:160

Inject a custom logger to route library output into your own logging stack. Defaults to a console logger filtered by verbosity. Use NullLogger to keep the library completely silent.

mediaDir?​

optional mediaDir?: string

Defined in: src/types/types.ts:82

Path to media directory, in case you need to import additional files. You can set a path here. Load files with Automizer.loadMedia

outputDir?​

optional outputDir?: string

Defined in: src/types/types.ts:77

Prefix for the output files for Automizer instance. You can set a path here.

pptxGenJs?​

optional pptxGenJs?: PptxGenJS

Defined in: src/types/types.ts:100

If you require another version of pptxGenJs, you can e.g. use your customized library.

presTemplates?​

optional presTemplates?: AutomizerFile[]

Defined in: src/types/types.ts:106

Array of template files to be loaded on initialization. If files are Buffer or Uint8Array, they will be named 0.pptx, 1.pptx, ... according to their order in the array.

removeExistingSlides?​

optional removeExistingSlides?: boolean

Defined in: src/types/types.ts:133

Delete all existing slides from rootTemplate before automation starts.

rootTemplate?​

optional rootTemplate?: AutomizerFile

Defined in: src/types/types.ts:95

Pass an AutomizerFile directly and skip loadRoot().

showIntegrityInfo?​

optional showIntegrityInfo?: boolean

Defined in: src/types/types.ts:122

In case you encounter weird pptx messages on opening a created presentation, you can turn this to true. It will log a message on missing related contents and help you to locate where it is. Use this along with "assertRelatedContents" to auto-fix broken relations.

statusTracker?​

optional statusTracker?: StatusTracker["next"]

Defined in: src/types/types.ts:147

statusTracker will be triggered on each appended slide. You can e.g. attach a custom callback to a progress bar.

templateDir?​

optional templateDir?: string

Defined in: src/types/types.ts:67

Prefix for all template files. You can set a path here.

templateFallbackDir?​

optional templateFallbackDir?: string

Defined in: src/types/types.ts:72

Specify a fallback directory if template file was not found in templateDir.

useCreationIds?​

optional useCreationIds?: boolean

Defined in: src/types/types.ts:107

verbosity?​

optional verbosity?: Verbosity

Defined in: src/types/types.ts:154

Set logging verbosity of the default console logger. 0: errors only 1: errors and warnings (default) 2: everything, including info (e.g. on import & append)