What is Incisor?
Tutorials
Key Concepts
Reddit
Stack Overflow
Configuration Settings
Deprecation Schedule

PdfHeader()

A PdfHeader is an object defining a heading element and the associated formatting within a PdfSection. Each section has exactly one PdfHeader. [NON-INSTANTIABLE]

new PdfHeader()

A PdfHeader is an object defining a heading element and the associated formatting with a PdfSection. Each section has exactly one PdfHeader. [NON-INSTANTIABLE]

MEMBERS

inheritedTypes :object

Dictionary object listing all of the types this object is compatible with.

type :string

Type identifier.

METHODS

addImage(imagePath, isPathRelative (opt), justificationH (opt), justificationV (opt)) returns {PdfImage}

Adds a new Image to this PdfHeader and returns it.

Parameters:
Name Type Attributes Default Description
imagePath string  

The path of the image being added to this PdfHeader.

isPathRelative boolean <optional>
 

Bool stating if the given path is relative to the project path or an absolute path. If an absolute path is used that is outside of the project directory, the 'allowUniversalFileIO' item in application settings must be set to true. [DEFAULT: true]

justificationH string <optional>
 

The horizontal justification of the image being added to this PdfHeader. For acceptable values, see 'nc.constants.justfications'.

justificationV string <optional>
 

The vertical justification of the image being added this PdfHeader. For acceptable values, see 'nc.constants.justfications'.

Returns:
PdfImage

addParagraph() returns {PdfParagraph}

Adds a new PdfParagraph to this PdfHeader and returns it. A PdfParagraph is simply a block of text.

Returns:
PdfParagraph

addTable(numRows, numCols, columnWidths) returns {PdfTable}

Adds a new PdfTable to this PdfHeader and returns it.

Parameters:
Name Type Attributes Default Description
numRows number    

The number of rows to add to this PdfTable.

numCols number    

The number of columns to add to each PdfRow in this PdfTable.

columnWidths Array.<number> | number    

An array containing the desired widths for each column in this PdfTable.

Returns:
PdfTable