Interface: ISlide
Defined in: src/interfaces/islide.ts:17
Properties
sourceArchive
sourceArchive:
IArchive
Defined in: src/interfaces/islide.ts:18
sourceNumber
sourceNumber:
SourceIdentifier
Defined in: src/interfaces/islide.ts:19
Methods
addElement()
addElement(
presName,slideNumber,selector,callback?):ISlide
Defined in: src/interfaces/islide.ts:38
Add an element from one of the loaded templates to this slide.
Parameters
presName
string
Filename or custom name of source template
slideNumber
number
The slide number or slide creationID where the source element can be found on
selector
The name or element creationID of the source element
callback?
ModificationCallback | ModificationCallback[]
You can pass a callback to modify the element on the target slide after insertion.
Returns
ISlide
append()
append(
targetTemplate):Promise<void>
Defined in: src/interfaces/islide.ts:29
Parameters
targetTemplate
RootPresTemplate
Returns
Promise<void>
generate()
generate(
generate,objectName?):ISlide
Defined in: src/interfaces/islide.ts:60
Use PptxGenJs to generate a new element from scratch on this slide.
Parameters
generate
GenerateOnSlideCallback
Pass a callback to create an element on current slide
objectName?
string
Give a custom name for this element or automizer will create a random uuid
Returns
ISlide
getAllElements()
getAllElements(
filterTags?):Promise<ElementInfo[]>
Defined in: src/interfaces/islide.ts:87
Parameters
filterTags?
string[]
Returns
Promise<ElementInfo[]>
getAllTextElementIds()
getAllTextElementIds():
Promise<string[]>
Defined in: src/interfaces/islide.ts:89
Returns
Promise<string[]>
getDimensions()
getDimensions():
Promise<{height:number;width:number; }>
Defined in: src/interfaces/islide.ts:96
Asynchronously retrieves the dimensions of a slide.
Returns
Promise<{ height: number; width: number; }>
getElement()
getElement(
selector):Promise<ElementInfo>
Defined in: src/interfaces/islide.ts:85
Parameters
selector
Returns
Promise<ElementInfo>
getGeneratedElements()
getGeneratedElements():
GenerateElements[]
Defined in: src/interfaces/islide.ts:91
Returns
GenerateElements[]
mergeIntoSlideLayout()
mergeIntoSlideLayout(
targetLayout):ISlide
Defined in: src/interfaces/islide.ts:83
Merges slide content into a specified slide layout by matching placeholders.
Parameters
targetLayout
string | number | SlideLayoutSelector
The layout identifier to merge into
Returns
ISlide
Promise resolving to the updated slide instance
modify()
modify(
callback):void
Defined in: src/interfaces/islide.ts:25
Will be executed after shape modification callbacks were executed
Parameters
callback
SlideModificationCallback
Returns
void
modifyElement()
modifyElement(
selector,callback):ISlide
Defined in: src/interfaces/islide.ts:50
Modify an element on the current slide.
Parameters
selector
The name or element creationID of the element on current slide
callback
ModificationCallback | ModificationCallback[]
Pass a callback to modify the element.
Returns
ISlide
modifyRelations()
modifyRelations(
callback):void
Defined in: src/interfaces/islide.ts:27
Parameters
callback
ModifyXmlCallback
Returns
void
prepare()
prepare(
callback):void
Defined in: src/interfaces/islide.ts:22
Will be executed before any shape modifications callback
Parameters
callback
SlideModificationCallback
Returns
void
remove()
remove(
number):void
Defined in: src/interfaces/islide.ts:103
Remove a slide from output. The slide will be calculated, but eventually withdrawn from slide list. Slide number starts by 1.
Parameters
number
number
Returns
void
removeElement()
removeElement(
selector):ISlide
Defined in: src/interfaces/islide.ts:66
You can remove an element on the current slide.
Parameters
selector
Pass element name or creationId to find target element.
Returns
ISlide
useSlideLayout()
useSlideLayout(
targetLayout?):ISlide
Defined in: src/interfaces/islide.ts:76
Use another slide layout of the output: by 1-based layout number, by
layout name (auto-imports the source slide's master, falls back to the
root template's layouts), or by a SlideLayoutSelector
({ layout, master?, template? }, resolved against the output at write
time, no auto-import). Without an argument the source slide's own
layout and master are imported.
Parameters
targetLayout?
string | number | SlideLayoutSelector
Returns
ISlide