Interface TextAffix

Defines PDF Header and Footer display options.

TextAffix uses a logical approach to rendering Headers and Footers for the most common use cases.

See

HtmlAffix

Hierarchy

  • TextAffix

Properties

centerText? dividerLine? dividerLineColor? font? fontSize? leftText? rightText?

Properties

Optional centerText

centerText?: string

Sets the centered header text for the PDF document.

Merge meta-data into your header using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

Optional dividerLine

dividerLine?: boolean

Adds a horizontal line divider between the header / footer and the page content on every page of the PDF document.

Default

false

Optional dividerLineColor

dividerLineColor?: string

A html color code for divider line color see dividerLine

Default

#b1b1b1

Optional font

font?: AffixFonts

Font family. Default is Arial.

Optional fontSize

fontSize?: number

Font size in px.

Default

10

Optional leftText

leftText?: string

Sets the left-hand side header text for the PDF document.

Merge meta-data into your header using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

Optional rightText

rightText?: string

Sets the right-hand side header text for the PDF document.

Merge meta-data into your header using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc