Class: XmlSlideHelper

Defined in: src/helper/xml-slide-helper.ts:39

Class that represents an XML slide helper

Constructors

Constructor

new XmlSlideHelper(slideXml, params): XmlSlideHelper

Defined in: src/helper/xml-slide-helper.ts:50

Constructor for the XmlSlideHelper class.

Parameters

slideXml

Document

The slide XML document to be used by the helper.

params

SlideHelperProps

Returns

XmlSlideHelper

Properties

slideNumber

protected slideNumber: number

Defined in: src/helper/xml-slide-helper.ts:42

---

sourceArchive

protected sourceArchive: IArchive

Defined in: src/helper/xml-slide-helper.ts:41

---

sourceLayoutId

protected sourceLayoutId: number

Defined in: src/helper/xml-slide-helper.ts:43

Methods

getAllElements()

getAllElements(filterTags?, layoutPlaceholders?): ElementInfo[]

Defined in: src/helper/xml-slide-helper.ts:99

Get an array of ElementInfo objects for all named elements on a slide.

Parameters

filterTags?

string[]

Use an array of strings to filter the output array

layoutPlaceholders?

PlaceholderInfo[]

Returns

ElementInfo[]

---

getAllTextElementIds()

getAllTextElementIds(useCreationIds?): string[]

Defined in: src/helper/xml-slide-helper.ts:124

Get all text element IDs from the slide.

Parameters

useCreationIds?

boolean

Returns

string[]

An array of text element IDs.

---

getAndExtractDimensions()

getAndExtractDimensions(path): Promise<{ height: number; width: number; }>

Defined in: src/helper/xml-slide-helper.ts:622

Fetches an XML file from the given path and extracts the dimensions.

Parameters

path

string

The path of the XML file.

Returns

Promise<{ height: number; width: number; }>

• A promise that resolves with an object containing the width and height, or null if there was an error.

---

getDimensions()

getDimensions(): Promise<{ height: number; width: number; }>

Defined in: src/helper/xml-slide-helper.ts:604

Asynchronously retrieves the dimensions of a slide. Tries to find the dimensions from the slide XML, then from the layout, master, and presentation XMLs in order.

Returns

Promise<{ height: number; width: number; }>

The dimensions of the slide.

Throws

Error if unable to determine dimensions.

---

getElement()

getElement(selector): Promise<ElementInfo>

Defined in: src/helper/xml-slide-helper.ts:86

Get an ElementInfo object for the target element on the slide.

Parameters

selector

string

Returns

Promise<ElementInfo>

---

getNamedElements()

getNamedElements(filterTags?): Element[]

Defined in: src/helper/xml-slide-helper.ts:180

Retrieves a list of all named elements on a slide. Automation requires at least a name.

Parameters

filterTags?

string[]

Use an array of strings to filter the output array

Returns

Element[]

---

getSlideCreationId()

getSlideCreationId(): number

Defined in: src/helper/xml-slide-helper.ts:60

Returns

number

---

getSlideLayout()

getSlideLayout(): Promise<LayoutInfo>

Defined in: src/helper/xml-slide-helper.ts:77

Returns

Promise<LayoutInfo>

---

getSlideLayoutXml()

getSlideLayoutXml(layoutId): Promise<Document>

Defined in: src/helper/xml-slide-helper.ts:579

Parameters

layoutId

number

Returns

Promise<Document>

---

getElementCreationId()

static getElementCreationId(slideElement, stripBrackets?): string

Defined in: src/helper/xml-slide-helper.ts:393

Parameters

slideElement

Element

stripBrackets?

boolean

Returns

string

---

getElementInfo()

static getElementInfo(slideElement, layoutPlaceholders?): ElementInfo

Defined in: src/helper/xml-slide-helper.ts:141

Parameters

slideElement

Element

layoutPlaceholders?

PlaceholderInfo[]

Returns

ElementInfo

---

getElementName()

static getElementName(slideElement): string

Defined in: src/helper/xml-slide-helper.ts:386

Parameters

slideElement

Element

Returns

string

---

getElementNameIdx()

static getElementNameIdx(slideElement): number

Defined in: src/helper/xml-slide-helper.ts:411

Parameters

slideElement

Element

Returns

number

---

getElementType()

static getElementType(slideElementParent): ElementType

Defined in: src/helper/xml-slide-helper.ts:452

Parses local tag name to specify element type in case it is a 'graphicFrame'.

Parameters

slideElementParent

Element

Returns

ElementType

---

getElementVisualType()

static getElementVisualType(element): ElementVisualType

Defined in: src/helper/xml-slide-helper.ts:700

Determines the type of visual element in PowerPoint

Parameters

element

Element

The XML element to check

Returns

ElementVisualType

A string identifying the element type

---

getImageAltText()

static getImageAltText(slideElement): string

Defined in: src/helper/xml-slide-helper.ts:379

Parameters

slideElement

Element

Returns

string

---

getNonVisibleProperties()

static getNonVisibleProperties(shapeNode): Element

Defined in: src/helper/xml-slide-helper.ts:375

Parameters

shapeNode

Element

Returns

Element

---

getSelector()

static getSelector(slideElement): FindElementMultiSelector

Defined in: src/helper/xml-slide-helper.ts:682

Reconstruct the complete selector for a given xmlElement, including the n-th occurance of the shape name on the current slide

Parameters

slideElement

Element

Returns

FindElementMultiSelector

---

getSlideLayoutXml()

static getSlideLayoutXml(sourceArchive, layoutId): Promise<Document>

Defined in: src/helper/xml-slide-helper.ts:583

Parameters

sourceArchive

IArchive

layoutId

number

Returns

Promise<Document>

---

getTextBody()

static getTextBody(shapeNode): Element

Defined in: src/helper/xml-slide-helper.ts:198

Parameters

shapeNode

Element

Returns

Element

---

groupSimilarParagraphs()

static groupSimilarParagraphs(paragraphs): TextParagraphGroup[]

Defined in: src/helper/xml-slide-helper.ts:317

Parameters

paragraphs

TextParagraph[]

Returns

TextParagraphGroup[]

---

parseCoordinate()

static parseCoordinate(element, attributeName): number

Defined in: src/helper/xml-slide-helper.ts:520

Parameters

element

Element

attributeName

string

Returns

number

---

parseGroupInfo()

static parseGroupInfo(element): GroupInfo

Defined in: src/helper/xml-slide-helper.ts:527

Parameters

element

Element

Returns

GroupInfo

---

parseParagraphGroups()

static parseParagraphGroups(shapeNode): TextParagraphGroup[]

Defined in: src/helper/xml-slide-helper.ts:218

Parameters

shapeNode

Element

Returns

TextParagraphGroup[]

---

parseShapeCoordinates()

static parseShapeCoordinates(slideElementParent, returnDefaults?): ElementPosition

Defined in: src/helper/xml-slide-helper.ts:480

Parameters

slideElementParent

Element

returnDefaults?

boolean

Returns

ElementPosition

---

parseTextFragments()

static parseTextFragments(shapeNode): string[]

Defined in: src/helper/xml-slide-helper.ts:202

Parameters

shapeNode

Element

Returns

string[]

---

parseTextParagraphs()

static parseTextParagraphs(shapeNode): TextParagraph[]

Defined in: src/helper/xml-slide-helper.ts:223

Parameters

shapeNode

Element

Returns

TextParagraph[]

---

readTableInfo()

static readTableInfo(element): TableInfo[]

Defined in: src/helper/xml-slide-helper.ts:642

Parameters

element

Element

Returns

TableInfo[]

---

setParagraphProperties()

static setParagraphProperties(pPr, paragraph): void

Defined in: src/helper/xml-slide-helper.ts:291

Parameters

pPr

Element

paragraph

TextParagraph

Returns

void

---

setTextProperties()

static setTextProperties(run, paragraph): void

Defined in: src/helper/xml-slide-helper.ts:276

Parameters

run

Element

paragraph

TextParagraph

Returns

void