PDFTron pdfnet-node

Class: TOCSettings

PDFNet.HTML2PDF. TOCSettings

new TOCSettings()

Settings for table of contents.

Extends

Methods

<static> create()

Constructor
Returns:
A promise that resolves to an object of type: "PDFNet.HTML2PDF.TOCSettings"
Type
Promise.<PDFNet.HTML2PDF.TOCSettings>

destroy()

Destructor
Inherited From:
Returns:
Type
Promise.<void>

setCaptionText(caption)

Caption text to be used with TOC.
Parameters:
Name Type Description
caption string Text that will appear with the table of contents. Note: This option is deprecated in the latest HTML2PDF module and may have no effect.
Returns:
Type
Promise.<void>

setDottedLines(enable)

Use a dotted line when creating TOC.
Parameters:
Name Type Description
enable boolean Table of contents will use dotted lines. Note: This option is deprecated in the latest HTML2PDF module and may have no effect.
Returns:
Type
Promise.<void>

setLevelIndentation(indentation)

Indentation used for every TOC level...
Parameters:
Name Type Description
indentation number How much to indent each level, e.g. "2" Note: This option is deprecated in the latest HTML2PDF module and may have no effect.
Returns:
Type
Promise.<void>
Create links from TOC to actual content.
Parameters:
Name Type Description
enable boolean Entries in table of contents will link to section in the PDF. Note: This option is deprecated in the latest HTML2PDF module and may have no effect.
Returns:
Type
Promise.<void>

setTextSizeShrink(shrink)

How much to shrink font for every level, e.g. 0.8
Parameters:
Name Type Description
shrink number Rate at which lower level entries will appear smaller Note: This option is deprecated in the latest HTML2PDF module and may have no effect.
Returns:
Type
Promise.<void>

setXsl(style_sheet)

xsl style sheet used to convert outline XML into a table of content.
Parameters:
Name Type Description
style_sheet string Path to xsl style sheet to be used to generate this table of contents. Note: This option is deprecated in the latest HTML2PDF module and may have no effect.
Returns:
Type
Promise.<void>

takeOwnership()

Take the ownership of this object, so that PDFNet.runWithCleanup won't destroy this object.
Inherited From:
Returns:
Type
void