new HTML2PDF_TOCSettings()
Settings for table of contents.
Methods
-
destroy()
-
Frees the native memory of the object.
-
setCaptionText(caption)
-
Caption text to be used with TOC.
Parameters:
Name Type Description caption
string Text that will appear with the table of contents.
-
setDottedLines(enable)
-
Use a dotted line when creating TOC.
Parameters:
Name Type Description enable
boolean Table of contents will use dotted lines.
-
setLevelIndentation(indentation)
-
Indentation used for every TOC level...
Parameters:
Name Type Description indentation
number How much to indent each level, e.g. "2"
-
setLinks(enable)
-
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.
-
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
-
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.