233 lines
40 KiB
HTML
233 lines
40 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ITableOfContentsOptions | docx</title><meta name="description" content="Documentation for docx"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
<div class="tsd-toolbar-contents container">
|
|
<div class="table-cell" id="tsd-search" data-base="..">
|
|
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
<div class="field">
|
|
<div id="tsd-toolbar-links"></div></div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">docx</a></div>
|
|
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
<div class="container container-main">
|
|
<div class="col-8 col-content">
|
|
<div class="tsd-page-title">
|
|
<ul class="tsd-breadcrumb">
|
|
<li><a href="../modules.html">docx</a></li>
|
|
<li><a href="ITableOfContentsOptions.html">ITableOfContentsOptions</a></li></ul>
|
|
<h1>Interface ITableOfContentsOptions</h1></div>
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography"><p>Options according to this docs:
|
|
<a href="https://www.ecma-international.org/publications/standards/Ecma-376.htm">https://www.ecma-international.org/publications/standards/Ecma-376.htm</a>
|
|
Part 1 - Page 1251</p>
|
|
<p>Short Guide:
|
|
<a href="http://officeopenxml.com/WPtableOfContents.php">http://officeopenxml.com/WPtableOfContents.php</a></p>
|
|
</div></section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h4>Hierarchy</h4>
|
|
<ul class="tsd-hierarchy">
|
|
<li><span class="target">ITableOfContentsOptions</span></li></ul></section><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L19">src/file/table-of-contents/table-of-contents-properties.ts:19</a></li></ul></aside>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
|
<div class="tsd-accordion-details">
|
|
<section class="tsd-index-section">
|
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
<div class="tsd-index-list"><a href="ITableOfContentsOptions.html#captionLabel" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>caption<wbr/>Label?</span></a>
|
|
<a href="ITableOfContentsOptions.html#captionLabelIncludingNumbers" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>caption<wbr/>Label<wbr/>Including<wbr/>Numbers?</span></a>
|
|
<a href="ITableOfContentsOptions.html#entriesFromBookmark" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>entries<wbr/>From<wbr/>Bookmark?</span></a>
|
|
<a href="ITableOfContentsOptions.html#entryAndPageNumberSeparator" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>entry<wbr/>And<wbr/>Page<wbr/>Number<wbr/>Separator?</span></a>
|
|
<a href="ITableOfContentsOptions.html#headingStyleRange" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>heading<wbr/>Style<wbr/>Range?</span></a>
|
|
<a href="ITableOfContentsOptions.html#hideTabAndPageNumbersInWebView" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>hide<wbr/>Tab<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>In<wbr/>Web<wbr/>View?</span></a>
|
|
<a href="ITableOfContentsOptions.html#hyperlink" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>hyperlink?</span></a>
|
|
<a href="ITableOfContentsOptions.html#pageNumbersEntryLevelsRange" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>page<wbr/>Numbers<wbr/>Entry<wbr/>Levels<wbr/>Range?</span></a>
|
|
<a href="ITableOfContentsOptions.html#preserveNewLineInEntries" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>preserve<wbr/>New<wbr/>Line<wbr/>In<wbr/>Entries?</span></a>
|
|
<a href="ITableOfContentsOptions.html#preserveTabInEntries" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>preserve<wbr/>Tab<wbr/>In<wbr/>Entries?</span></a>
|
|
<a href="ITableOfContentsOptions.html#seqFieldIdentifierForPrefix" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>seq<wbr/>Field<wbr/>Identifier<wbr/>For<wbr/>Prefix?</span></a>
|
|
<a href="ITableOfContentsOptions.html#sequenceAndPageNumbersSeparator" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>sequence<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>Separator?</span></a>
|
|
<a href="ITableOfContentsOptions.html#stylesWithLevels" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>styles<wbr/>With<wbr/>Levels?</span></a>
|
|
<a href="ITableOfContentsOptions.html#tcFieldIdentifier" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>tc<wbr/>Field<wbr/>Identifier?</span></a>
|
|
<a href="ITableOfContentsOptions.html#tcFieldLevelRange" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>tc<wbr/>Field<wbr/>Level<wbr/>Range?</span></a>
|
|
<a href="ITableOfContentsOptions.html#useAppliedParagraphOutlineLevel" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>use<wbr/>Applied<wbr/>Paragraph<wbr/>Outline<wbr/>Level?</span></a>
|
|
</div></section></div></details></section></section>
|
|
<section class="tsd-panel-group tsd-member-group">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="captionLabel" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>caption<wbr/>Label</span><a href="#captionLabel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
|
|
<div class="tsd-signature">caption<wbr/>Label<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\a option - Includes captioned items, but omits caption labels and numbers.
|
|
The identifier designated by text in this switch's field-argument corresponds to the caption label.
|
|
Use captionLabelIncludingNumbers (\c) to build a table of captions with labels and numbers.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L25">src/file/table-of-contents/table-of-contents-properties.ts:25</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="captionLabelIncludingNumbers" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>caption<wbr/>Label<wbr/>Including<wbr/>Numbers</span><a href="#captionLabelIncludingNumbers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">caption<wbr/>Label<wbr/>Including<wbr/>Numbers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\c option - Includes figures, tables, charts, and other items that are numbered
|
|
by a SEQ field (§17.16.5.56). The sequence identifier designated by text in this switch's
|
|
field-argument, which corresponds to the caption label, shall match the identifier in the
|
|
corresponding SEQ field.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L39">src/file/table-of-contents/table-of-contents-properties.ts:39</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="entriesFromBookmark" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>entries<wbr/>From<wbr/>Bookmark</span><a href="#entriesFromBookmark" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">entries<wbr/>From<wbr/>Bookmark<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\b option - Includes entries only from the portion of the document marked by
|
|
the bookmark named by text in this switch's field-argument.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L31">src/file/table-of-contents/table-of-contents-properties.ts:31</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="entryAndPageNumberSeparator" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>entry<wbr/>And<wbr/>Page<wbr/>Number<wbr/>Separator</span><a href="#entryAndPageNumberSeparator" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">entry<wbr/>And<wbr/>Page<wbr/>Number<wbr/>Separator<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\p option - Text in this switch's field-argument specifies a sequence of characters
|
|
that separate an entry and its page number. The default is a tab with leader dots.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L86">src/file/table-of-contents/table-of-contents-properties.ts:86</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="headingStyleRange" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>heading<wbr/>Style<wbr/>Range</span><a href="#headingStyleRange" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">heading<wbr/>Style<wbr/>Range<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\o option - Uses paragraphs formatted with all or the specified range of builtin
|
|
heading styles. Headings in a style range are specified by text in this switch's
|
|
field-argument using the notation specified as for \l, where each integer corresponds
|
|
to the style with a style ID of HeadingX (e.g. 1 corresponds to Heading1).
|
|
If no heading range is specified, all heading levels used in the document are listed.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L80">src/file/table-of-contents/table-of-contents-properties.ts:80</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="hideTabAndPageNumbersInWebView" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>hide<wbr/>Tab<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>In<wbr/>Web<wbr/>View</span><a href="#hideTabAndPageNumbersInWebView" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">hide<wbr/>Tab<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>In<wbr/>Web<wbr/>View<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\z Hides tab leader and page numbers in web page view (§17.18.102).</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L121">src/file/table-of-contents/table-of-contents-properties.ts:121</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="hyperlink" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>hyperlink</span><a href="#hyperlink" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">hyperlink<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\h option - Makes the table of contents entries hyperlinks.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L56">src/file/table-of-contents/table-of-contents-properties.ts:56</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pageNumbersEntryLevelsRange" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>page<wbr/>Numbers<wbr/>Entry<wbr/>Levels<wbr/>Range</span><a href="#pageNumbersEntryLevelsRange" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">page<wbr/>Numbers<wbr/>Entry<wbr/>Levels<wbr/>Range<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\n option - Without field-argument, omits page numbers from the table of contents.
|
|
Page numbers are omitted from all levels unless a range of entry levels is specified by
|
|
text in this switch's field-argument. A range is specified as for \l.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L71">src/file/table-of-contents/table-of-contents-properties.ts:71</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="preserveNewLineInEntries" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>preserve<wbr/>New<wbr/>Line<wbr/>In<wbr/>Entries</span><a href="#preserveNewLineInEntries" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">preserve<wbr/>New<wbr/>Line<wbr/>In<wbr/>Entries<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\x Preserves newline characters within table entries.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L116">src/file/table-of-contents/table-of-contents-properties.ts:116</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="preserveTabInEntries" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>preserve<wbr/>Tab<wbr/>In<wbr/>Entries</span><a href="#preserveTabInEntries" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">preserve<wbr/>Tab<wbr/>In<wbr/>Entries<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\w Preserves tab entries within table entries.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L111">src/file/table-of-contents/table-of-contents-properties.ts:111</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="seqFieldIdentifierForPrefix" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>seq<wbr/>Field<wbr/>Identifier<wbr/>For<wbr/>Prefix</span><a href="#seqFieldIdentifierForPrefix" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">seq<wbr/>Field<wbr/>Identifier<wbr/>For<wbr/>Prefix<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\s option - For entries numbered with a SEQ field (§17.16.5.56), adds a prefix to the page number.
|
|
The prefix depends on the type of entry. text in this switch's field-argument shall match the
|
|
identifier in the SEQ field.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L93">src/file/table-of-contents/table-of-contents-properties.ts:93</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sequenceAndPageNumbersSeparator" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>sequence<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>Separator</span><a href="#sequenceAndPageNumbersSeparator" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">sequence<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>Separator<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\d option - When used with \s, the text in this switch's field-argument defines
|
|
the separator between sequence and page numbers. The default separator is a hyphen (-).</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L45">src/file/table-of-contents/table-of-contents-properties.ts:45</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="stylesWithLevels" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>styles<wbr/>With<wbr/>Levels</span><a href="#stylesWithLevels" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">styles<wbr/>With<wbr/>Levels<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">readonly </span><a href="../classes/StyleLevel.html" class="tsd-signature-type" data-tsd-kind="Class">StyleLevel</a><span class="tsd-signature-symbol">[]</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\t field-argument Uses paragraphs formatted with styles other than the built-in heading styles.
|
|
Text in this switch's field-argument specifies those styles as a set of comma-separated doublets,
|
|
with each doublet being a comma-separated set of style name and table of content level.
|
|
\t can be combined with \o.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L101">src/file/table-of-contents/table-of-contents-properties.ts:101</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tcFieldIdentifier" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tc<wbr/>Field<wbr/>Identifier</span><a href="#tcFieldIdentifier" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">tc<wbr/>Field<wbr/>Identifier<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\f option - Includes only those TC fields whose identifier exactly matches the
|
|
text in this switch's field-argument (which is typically a letter).</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L51">src/file/table-of-contents/table-of-contents-properties.ts:51</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tcFieldLevelRange" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tc<wbr/>Field<wbr/>Level<wbr/>Range</span><a href="#tcFieldLevelRange" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">tc<wbr/>Field<wbr/>Level<wbr/>Range<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\l option - Includes TC fields that assign entries to one of the levels specified
|
|
by text in this switch's field-argument as a range having the form startLevel-endLevel,
|
|
where startLevel and endLevel are integers, and startLevel has a value equal-to or less-than endLevel.
|
|
TC fields that assign entries to lower levels are skipped.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L64">src/file/table-of-contents/table-of-contents-properties.ts:64</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="useAppliedParagraphOutlineLevel" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>use<wbr/>Applied<wbr/>Paragraph<wbr/>Outline<wbr/>Level</span><a href="#useAppliedParagraphOutlineLevel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">use<wbr/>Applied<wbr/>Paragraph<wbr/>Outline<wbr/>Level<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>\u Uses the applied paragraph outline level.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e55698d/src/file/table-of-contents/table-of-contents-properties.ts#L106">src/file/table-of-contents/table-of-contents-properties.ts:106</a></li></ul></aside></section></section></div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<div class="tsd-navigation settings">
|
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<div class="tsd-filter-visibility">
|
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
<ul id="tsd-filter-options">
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
<div class="tsd-theme-toggle">
|
|
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
<nav class="tsd-navigation primary">
|
|
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<ul>
|
|
<li><a href="../modules.html">docx</a>
|
|
<ul></ul></li></ul></div></details></nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul>
|
|
<li class="current tsd-kind-interface"><a href="ITableOfContentsOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>ITable<wbr/>Of<wbr/>Contents<wbr/>Options</span></a>
|
|
<ul>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#captionLabel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>caption<wbr/>Label?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#captionLabelIncludingNumbers" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>caption<wbr/>Label<wbr/>Including<wbr/>Numbers?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#entriesFromBookmark" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>entries<wbr/>From<wbr/>Bookmark?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#entryAndPageNumberSeparator" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>entry<wbr/>And<wbr/>Page<wbr/>Number<wbr/>Separator?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#headingStyleRange" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>heading<wbr/>Style<wbr/>Range?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#hideTabAndPageNumbersInWebView" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>hide<wbr/>Tab<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>In<wbr/>Web<wbr/>View?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#hyperlink" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>hyperlink?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#pageNumbersEntryLevelsRange" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>page<wbr/>Numbers<wbr/>Entry<wbr/>Levels<wbr/>Range?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#preserveNewLineInEntries" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>preserve<wbr/>New<wbr/>Line<wbr/>In<wbr/>Entries?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#preserveTabInEntries" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>preserve<wbr/>Tab<wbr/>In<wbr/>Entries?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#seqFieldIdentifierForPrefix" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>seq<wbr/>Field<wbr/>Identifier<wbr/>For<wbr/>Prefix?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#sequenceAndPageNumbersSeparator" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>sequence<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>Separator?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#stylesWithLevels" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>styles<wbr/>With<wbr/>Levels?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#tcFieldIdentifier" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>tc<wbr/>Field<wbr/>Identifier?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#tcFieldLevelRange" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>tc<wbr/>Field<wbr/>Level<wbr/>Range?</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#useAppliedParagraphOutlineLevel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>use<wbr/>Applied<wbr/>Paragraph<wbr/>Outline<wbr/>Level?</a></li></ul></li></ul></nav></div></div>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
<div class="overlay"></div><script src="../assets/main.js"></script></body></html> |