Class PageBreak

The class for a page break property.

Hierarchy

Property
- PageBreak

Index

Constructors

constructor

Properties

name
value

Methods

Constructors

constructor

new PageBreak(name: string, value: string | boolean): PageBreak

Overrides Property.constructor
- Defined in src/elements/elements.ts:1060
Parameters
- name: string
  
  the name for this property
- value: string | boolean
  
  Value should be set to 'page' or 'pagebreak' for PageBreak, 'column' or 'columnbreak' for column breaks. If set to True (default) it will create a pagebreak.
Returns PageBreak

Properties

name

name: string

value

value: unknown

Methods

asDict

asDict(): {}

Inherited from Property.asDict
- Defined in src/elements/elements.ts:329
Dictionary representation of this Element.

Returns {}

dictionary representation of this Element
- [key: string]: unknown

availableTags

availableTags(): Set<string>

Overrides Property.availableTags
- Defined in src/elements/elements.ts:1068
A set containing all available template tags this Element reacts to.

Returns Set<string>

set of tags associated with this Element

Generated using TypeDoc