IronsheetIronsheet
API Reference@ironsheet/coreClasses

OoxmlPackage

Class: OoxmlPackage

Defined in: packages/core/src/opc.ts:33

Properties

parts

readonly parts: Map<string, PackagePart>;

Defined in: packages/core/src/opc.ts:34

Methods

addPart()

addPart(partName, data): void;

Defined in: packages/core/src/opc.ts:117

Parameters

partName

string

data

Uint8Array

Returns

void


addTextPart()

addTextPart(partName, text): void;

Defined in: packages/core/src/opc.ts:105

Parameters

partName

string

text

string

Returns

void


deletePart()

deletePart(partName): boolean;

Defined in: packages/core/src/opc.ts:129

Parameters

partName

string

Returns

boolean


hasPart()

hasPart(partName): boolean;

Defined in: packages/core/src/opc.ts:56

Parameters

partName

string

Returns

boolean


inspect()

inspect(): Promise<PackageInspectResult>;

Defined in: packages/core/src/opc.ts:353

Returns

Promise<PackageInspectResult>


listParts()

listParts(): string[];

Defined in: packages/core/src/opc.ts:52

Returns

string[]


nextRelationshipId()

nextRelationshipId(partName, prefix?): Promise<string>;

Defined in: packages/core/src/opc.ts:177

Parameters

partName

string

prefix?

string = "rId"

Returns

Promise<string>


readPart()

readPart(partName): Promise<Uint8Array<ArrayBufferLike>>;

Defined in: packages/core/src/opc.ts:60

Parameters

partName

string

Returns

Promise<Uint8Array<ArrayBufferLike>>


readText()

readText(partName): Promise<string>;

Defined in: packages/core/src/opc.ts:77

Parameters

partName

string

Returns

Promise<string>


relationshipsFor()

relationshipsFor(partName): Promise<Relationship[]>;

Defined in: packages/core/src/opc.ts:133

Parameters

partName

string

Returns

Promise<Relationship[]>


removeContentTypeOverride()

removeContentTypeOverride(partName): Promise<boolean>;

Defined in: packages/core/src/opc.ts:250

Parameters

partName

string

Returns

Promise<boolean>


removeRelationships()

removeRelationships(partName, predicate): Promise<number>;

Defined in: packages/core/src/opc.ts:144

Parameters

partName

string

predicate

(relationship) => boolean

Returns

Promise<number>


rootRelationships()

rootRelationships(): Promise<Relationship[]>;

Defined in: packages/core/src/opc.ts:345

Returns

Promise<Relationship[]>


setPart()

setPart(partName, data): void;

Defined in: packages/core/src/opc.ts:93

Parameters

partName

string

data

Uint8Array

Returns

void


setText()

setText(partName, text): void;

Defined in: packages/core/src/opc.ts:81

Parameters

partName

string

text

string

Returns

void


upsertContentTypeDefault()

upsertContentTypeDefault(extension, contentType): Promise<void>;

Defined in: packages/core/src/opc.ts:270

Parameters

extension

string

contentType

string

Returns

Promise<void>


upsertContentTypeOverride()

upsertContentTypeOverride(partName, contentType): Promise<void>;

Defined in: packages/core/src/opc.ts:308

Parameters

partName

string

contentType

string

Returns

Promise<void>


upsertRelationship()

upsertRelationship(partName, relationship): Promise<void>;

Defined in: packages/core/src/opc.ts:198

Parameters

partName

string

relationship

Relationship

Returns

Promise<void>


write()

write(): Promise<Uint8Array<ArrayBufferLike>>;

Defined in: packages/core/src/opc.ts:377

Returns

Promise<Uint8Array<ArrayBufferLike>>


open()

static open(data, compression): OoxmlPackage;

Defined in: packages/core/src/opc.ts:48

Parameters

data

Uint8Array

compression

CompressionAdapter

Returns

OoxmlPackage

On this page