new PdfFooter()
A PdfFooter is an object defining the footer element and associated formatting within a PdfSection.
- Each section has exactly one PdfFooter. [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 PdfFooter and returns it.
Parameters:
Name Type Attributes Default Description imagePath
string The path of the image being added to this PdfFooter.
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 PdfFooter. For acceptable values, see 'nc.constants.justfications'. [DEFAULT: "center"]
justificationV
string <optional>
The vertical justification of the image being added to this PdfFooter. For acceptable values, see 'nc.constants.justfications'. [DEFAULT: "center"]
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 PdfFooter 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