Overview

Namespaces

  • None
  • PHP
  • WkHtmlToPdf
    • Options

Traits

  • GlobalOptionsTrait
  • HeaderFooterOptionsTrait
  • OutlineOptionsTrait
  • PageOptionsTrait
  • TocOptionsTrait
  • Overview
  • Namespace
  • Class
  • Tree

Trait TocOptionsTrait

Direct Known Users

WkHtmlToPdf\WkHtmlToPdf
Namespace: WkHtmlToPdf\Options
Author: ivanpepelko
Located at WkHtmlToPdf/Options/TocOptionsTrait.php
Methods summary
public WkHtmlToPdf\WkHtmlToPdf
# disableTocDottedLines( )

Do not use dotted lines in the toc.

Do not use dotted lines in the toc.

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# enableTocDottedLines( )

Use dotted lines in the toc (if dotted lines are present in html).

Use dotted lines in the toc (if dotted lines are present in html).

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setTocHeaderText( string $text = 'Table of Contents' )

The header text of the toc (default 'Table of Contents').

The header text of the toc (default 'Table of Contents').

Parameters

$text

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setTocLevelIndentation( string $width = '1em' )

For each level of headings in the toc indent by this length (default 1em).

For each level of headings in the toc indent by this length (default 1em).

Parameters

$width

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# disableTocLinks( )

Do not link from toc to sections.

Do not link from toc to sections.

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# enableTocLinks( )

Link from toc to sections (only if it was disabled by disableTocLinks()).

Link from toc to sections (only if it was disabled by disableTocLinks()).

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setTocTextSizeShrinking( float $factor = 0.8 )

For each level of headings in the toc the font is scaled by this factor (default 0.8).

For each level of headings in the toc the font is scaled by this factor (default 0.8).

Parameters

$factor

Returns

WkHtmlToPdf\WkHtmlToPdf
public WkHtmlToPdf\WkHtmlToPdf
# setTocXslStyleSheet( string $path )

Use the supplied xsl style sheet for printing the table of content.

Use the supplied xsl style sheet for printing the table of content.

Parameters

$path
Path to xsl style sheet

Returns

WkHtmlToPdf\WkHtmlToPdf
wkp2p API documentation generated by ApiGen