MEMBERS

inheritedTypes :object

IncisorAPI.js, line 10301

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

type :string

IncisorAPI.js, line 10295

Type identifier.

METHODS

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

IncisorAPI.js, line 10319

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}

IncisorAPI.js, line 10308

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}

IncisorAPI.js, line 10329

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

addTextFrame(width, height) returns {PdfTextFrame}

IncisorAPI.js, line 10337

Adds a new PdfTextFrame to this PdfSection and returns it.

Parameters:

Name	Type	Attributes	Default	Description
width	number			The width of the PdfTextFrame being added.
height	number			The height of the PdfTextFrame being added.

Returns:

PdfTextFrame