cupertino-files / PagesSection

Class: PagesSection

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

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:117

Parameters

document

PagesDocument

object

IwaObject

index

number

start

number

end

number

Returns

PagesSection

Properties

document

readonly document: PagesDocument

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

---

end

readonly end: number

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

---

index

readonly index: number

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

---

object

readonly object: IwaObject

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

---

start

readonly start: number

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

Body-text range this section spans.

Accessors

evenOddDifferent

Get Signature

get evenOddDifferent(): boolean

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

Returns

boolean

---

firstPageDifferent

Get Signature

get firstPageDifferent(): boolean

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

Returns

boolean

---

id

Get Signature

get id(): bigint

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

Returns

bigint

---

name

Get Signature

get name(): string | undefined

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

Returns

string | undefined

Set Signature

set name(value): void

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

Parameters

value

string | undefined

Returns

void

---

pageNumberStart

Get Signature

get pageNumberStart(): number | undefined

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

Returns

number | undefined

Set Signature

set pageNumberStart(value): void

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

Parameters

value

number | undefined

Returns

void

Methods

footerText()

footerText(column?): string

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

Parameters

column?

number = 1

Returns

string

---

headerText()

headerText(column?): string

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

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:241

Returns

object[]

---

moveToSectionMaster()

moveToSectionMaster(drawableId, role?): void

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

Move a drawable from its page onto this section's master, so it repeats on every page the master draws: the app's Arrange ▸ Section Masters ▸ Move Object to Section Master. The drawable leaves its page group and paint order and loses its parent, and the master names it in its own list — the shape of every master drawable in the corpus, app-written on request and in two earlier documents. role picks which master; the app uses the odd one.

Parameters

drawableId

bigint

role?

"first" | "even" | "odd"

Returns

void

---

setFooterText()

setFooterText(text, column?): void

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

Parameters

text

string

column?

number = 1

Returns

void

---

setHeaderText()

setHeaderText(text, column?): void

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

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:156

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

Returns

SectionTemplateInfo[]