Skip to main content

QPdfWhenNode

@quik/pdf

@quik/pdf / QPdfWhenNode

Interface: QPdfWhenNode

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

Conditional node that renders one branch based on a test.

Extends​

Properties​

alignment?​

optional alignment?: "left" | "center" | "right" | "justify"

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

Optional alignment.

Inherited from​

QPdfNodeBase.alignment

else?​

optional else?: QPdfNode | QPdfNode[]

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

Optional content rendered when the test is falsy.

margin?​

optional margin?: [number, number] | [number, number, number, number]

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

Optional margin for the node.

Inherited from​

QPdfNodeBase.margin

pageBreak?​

optional pageBreak?: "before" | "after"

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

Optional page break instruction.

Inherited from​

QPdfNodeBase.pageBreak

style?​

optional style?: string | string[]

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

Optional named style defined in the template styles map.

Inherited from​

QPdfNodeBase.style

test​

test: string | number | boolean

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

Test expression or static value.

then​

then: QPdfNode | QPdfNode[]

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

Content rendered when the test is truthy.

type​

type: "when"

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

Type discriminator.