Class BandBuilder

Sub-builder for a page-frame band (page header / footer) — a band reserves space on every page, so it has its own config beyond just blocks: add blocks incrementally with addBlock(), and the reserved height is auto-measured from them (no magic number) unless you pin it with height(). Empty = no band. For a layout the block tree can't express, drop to a raw render() callback.

Index

Constructors

Methods

addBlock height render showOnFirstPage toBand

Constructors

constructor

new BandBuilder(): BandBuilder

Returns BandBuilder

Methods

addBlock

addBlock(...blocks: ReportNodeInput[]): this
append one or more blocks to the band (row / image / text / divider …)
Parameters
- ...blocks: ReportNodeInput[]
Returns this
- Defined in report/report-builder.ts:31

height

height(mm: number): this
pin the reserved height (mm) — default: auto-measured from the blocks
Parameters
- mm: number
Returns this
- Defined in report/report-builder.ts:38

render

render(callback: PageBandRenderer, height: number): this
raw jsPDF escape hatch — draw the band yourself; a height is required (can't auto-measure a callback)
Parameters
- callback: PageBandRenderer
- height: number
Returns this
- Defined in report/report-builder.ts:52

showOnFirstPage

showOnFirstPage(show: boolean): this
draw on the first page too? — default true
Parameters
- show: boolean
Returns this
- Defined in report/report-builder.ts:45

toBand

toBand(): KapomPageBandInput | undefined
the band config, or undefined if nothing was configured

Returns KapomPageBandInput | undefined
- Defined in report/report-builder.ts:60