QPdfTemplateDefinition

@quik/pdf

---

@quik/pdf / QPdfTemplateDefinition

Interface: QPdfTemplateDefinition

Defined in: pdf/src/types.ts:335

PDF template definition loaded from YAML or JSON.

Properties

background?

optional background?: QPdfHeaderFooter

Defined in: pdf/src/types.ts:379

Optional background definition.

---

content?

optional content?: QPdfNode[]

Defined in: pdf/src/types.ts:367

Main document content.

---

defaultStyle?

optional defaultStyle?: ObjectLiteral

Defined in: pdf/src/types.ts:355

Default style for the document.

---

doc?

optional doc?: ObjectLiteral

Defined in: pdf/src/types.ts:351

Document-level pdfmake options.

---

extends?

optional extends?: string

Defined in: pdf/src/types.ts:343

Optional base template to extend.

---

footer?

optional footer?: QPdfHeaderFooter

Defined in: pdf/src/types.ts:375

Optional footer definition.

---

header?

optional header?: QPdfHeaderFooter

Defined in: pdf/src/types.ts:371

Optional header definition.

---

images?

optional images?: Record<string, string>

Defined in: pdf/src/types.ts:363

Image definitions.

---

merge?

optional merge?: QPdfTemplateMerge

Defined in: pdf/src/types.ts:347

Merge strategies for inherited sections.

---

metadata?

optional metadata?: ObjectLiteral

Defined in: pdf/src/types.ts:383

Optional metadata.

---

name?

optional name?: string

Defined in: pdf/src/types.ts:339

Optional template name.

---

styles?

optional styles?: Record<string, ObjectLiteral>

Defined in: pdf/src/types.ts:359

Named styles referenced by nodes.