cupertino-files / PagesSection

Class: PagesSection

Defined in: src/pages/document.ts:104

cupertino-files — read, inspect and edit Apple iWork documents (Pages, Numbers, Keynote) in pure TypeScript with zero runtime dependencies.

Layering (each importable on its own): primitives: snappy, protobuf wire (RawMessage), zip, varint, crc32 container: IWorkContainer (package layouts), IWA archives (IwaObject) graph: ObjectStore (components, IDs, references, save invariants) model: IWorkDocument + TextStorage/StylesheetModel/DrawableModel apps: PagesDocument, NumbersDocument, KeynoteDocument

Constructors

Constructor

new PagesSection(document, object, index, start, end): PagesSection

Defined in: src/pages/document.ts:112

Parameters

document

PagesDocument

object

IwaObject

index

number

start

number

end

number

Returns

PagesSection

Properties

document

readonly document: PagesDocument

Defined in: src/pages/document.ts:105

---

end

readonly end: number

Defined in: src/pages/document.ts:109

---

index

readonly index: number

Defined in: src/pages/document.ts:110

---

object

readonly object: IwaObject

Defined in: src/pages/document.ts:106

---

start

readonly start: number

Defined in: src/pages/document.ts:108

Body-text range this section spans.

Accessors

evenOddDifferent

Get Signature

get evenOddDifferent(): boolean

Defined in: src/pages/document.ts:146

Returns

boolean

---

firstPageDifferent

Get Signature

get firstPageDifferent(): boolean

Defined in: src/pages/document.ts:142

Returns

boolean

---

id

Get Signature

get id(): bigint

Defined in: src/pages/document.ts:120

Returns

bigint

---

name

Get Signature

get name(): string | undefined

Defined in: src/pages/document.ts:124

Returns

string | undefined

Set Signature

set name(value): void

Defined in: src/pages/document.ts:128

Parameters

value

string | undefined

Returns

void

---

pageNumberStart

Get Signature

get pageNumberStart(): number | undefined

Defined in: src/pages/document.ts:133

Returns

number | undefined

Set Signature

set pageNumberStart(value): void

Defined in: src/pages/document.ts:137

Parameters

value

number | undefined

Returns

void

Methods

footerText()

footerText(column?): string

Defined in: src/pages/document.ts:194

Parameters

column?

number = 1

Returns

string

---

headerText()

headerText(column?): string

Defined in: src/pages/document.ts:188

Header/footer text of this section, from the odd-page master (the default variant Pages shows). Slot 1 — the default — is the field modern Pages draws, page-wide; 0 and 2 are the legacy layout's outer slots.

Parameters

column?

number = 1

Returns

string

---

masterDrawables()

masterDrawables(): object[]

Defined in: src/pages/document.ts:204

Drawables placed on this section's master pages (watermarks, logos, repeating page furniture), keyed by page-master role.

Returns

object[]

---

setFooterText()

setFooterText(text, column?): void

Defined in: src/pages/document.ts:230

Parameters

text

string

column?

number = 1

Returns

void

---

setHeaderText()

setHeaderText(text, column?): void

Defined in: src/pages/document.ts:226

Write header text into every page-master variant. The default slot 1 is the field modern Pages draws — one page-wide field whose text renders with its own paragraph alignment; slots 0 and 2 are the legacy layout's outer slots, preserved but not drawn in modern documents. Text written into a previously-empty slot copies the attribute shape of a non-empty sibling — its paragraph style, character-table and language entries — because a bare setText leaves the donor's empty-storage shape.

Parameters

text

string

column?

number = 1

Returns

void

---

templates()

templates(): SectionTemplateInfo[]

Defined in: src/pages/document.ts:151

The section's page-master variants with their header/footer storages.

Returns

SectionTemplateInfo[]