Skip to main content

Class: XmlRelationshipHelper

Defined in: src/helper/xml-relationship-helper.ts:10

Constructors​

Constructor​

new XmlRelationshipHelper(xml?, tag?): XmlRelationshipHelper

Defined in: src/helper/xml-relationship-helper.ts:19

Parameters​

xml?​

Document

tag?​

string

Returns​

XmlRelationshipHelper

Properties​

archive​

archive: IArchive

Defined in: src/helper/xml-relationship-helper.ts:11

file​

file: string

Defined in: src/helper/xml-relationship-helper.ts:12

path​

path: string

Defined in: src/helper/xml-relationship-helper.ts:13

tag​

tag: string

Defined in: src/helper/xml-relationship-helper.ts:14

targets​

targets: Target[] = []

Defined in: src/helper/xml-relationship-helper.ts:17

xml​

xml: Document

Defined in: src/helper/xml-relationship-helper.ts:15

xmlTargets​

xmlTargets: Element[] = []

Defined in: src/helper/xml-relationship-helper.ts:16

Methods​

assertRelatedContent()​

assertRelatedContent(sourceArchive, check?, assert?): Promise<void>

Defined in: src/helper/xml-relationship-helper.ts:127

This will copy all unhandled related contents into the target archive.

Pptx messages on opening a corrupted file are most likely caused by broken relations and this is going to prevent files from being missed.

Parameters​

sourceArchive​

IArchive

check?​

boolean

assert?​

boolean

Returns​

Promise<void>

getTargetByRelId()​

getTargetByRelId(findRid): Target

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

Parameters​

findRid​

string

Returns​

Target

getTargetsByPrefix()​

getTargetsByPrefix(prefix): Target[]

Defined in: src/helper/xml-relationship-helper.ts:55

Parameters​

prefix​

string | string[]

Returns​

Target[]

getTargetsByType()​

getTargetsByType(type): Target[]

Defined in: src/helper/xml-relationship-helper.ts:75

Parameters​

type​

string

Returns​

Target[]

initialize()​

initialize(archive, file, path, prefix?): Promise<Target[] | XmlRelationshipHelper>

Defined in: src/helper/xml-relationship-helper.ts:27

Parameters​

archive​

IArchive

file​

string

path​

string

prefix?​

string

Returns​

Promise<Target[] | XmlRelationshipHelper>

readTargets()​

readTargets(): this

Defined in: src/helper/xml-relationship-helper.ts:96

Returns​

this

setXml()​

setXml(xml): XmlRelationshipHelper

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

Parameters​

xml​

Document

Returns​

XmlRelationshipHelper

extendTarget()​

static extendTarget(prefix, subtype, target): Target

Defined in: src/helper/xml-relationship-helper.ts:245

Parameters​

prefix​

string

subtype​

ElementSubtype

target​

Target

Returns​

Target

getSlideLayoutNumber()​

static getSlideLayoutNumber(sourceArchive, slideId): Promise<number>

Defined in: src/helper/xml-relationship-helper.ts:274

Parameters​

sourceArchive​

IArchive

slideId​

number

Returns​

Promise<number>

getSlideMasterNumber()​

static getSlideMasterNumber(sourceArchive, slideLayoutId): Promise<number>

Defined in: src/helper/xml-relationship-helper.ts:284

Parameters​

sourceArchive​

IArchive

slideLayoutId​

number

Returns​

Promise<number>

parseRelationTarget()​

static parseRelationTarget(element, prefix?, matchByPrefix?): Target

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

Parameters​

element​

Element

prefix?​

string

matchByPrefix?​

boolean

Returns​

Target

targetMatchesRelationship()​

static targetMatchesRelationship(relType, subtype, target, prefix): boolean

Defined in: src/helper/xml-relationship-helper.ts:263

Parameters​

relType​

string

subtype​

string

target​

string

prefix​

string

Returns​

boolean