Deploying to gh-pages from @ dolanmiu/docx@568c764e3c 🚀
This commit is contained in:
@ -1,11 +1,13 @@
|
||||
<!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 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"><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 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>
|
||||
<li class="state failure">The search index is not available</li></ul><a href="" 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">
|
||||
@ -25,7 +27,7 @@ Part 1 - Page 1251</p>
|
||||
<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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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">
|
||||
@ -60,7 +62,7 @@ The identifier designated by text in this switch's field-argument correspond
|
||||
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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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>
|
||||
@ -70,7 +72,7 @@ field-argument, which corresponds to the caption label, shall match the identifi
|
||||
corresponding SEQ field.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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>
|
||||
@ -78,7 +80,7 @@ corresponding SEQ field.</p>
|
||||
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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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>
|
||||
@ -86,7 +88,7 @@ the bookmark named by text in this switch's field-argument.</p>
|
||||
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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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>
|
||||
@ -97,21 +99,21 @@ 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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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>
|
||||
@ -120,21 +122,21 @@ Page numbers are omitted from all levels unless a range of entry levels is speci
|
||||
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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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>
|
||||
@ -143,7 +145,7 @@ The prefix depends on the type of entry. text in this switch's field-argumen
|
||||
identifier in the SEQ field.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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>
|
||||
@ -151,7 +153,7 @@ identifier in the SEQ field.</p>
|
||||
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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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>
|
||||
@ -161,7 +163,7 @@ with each doublet being a comma-separated set of style name and table of content
|
||||
\t can be combined with \o.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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>
|
||||
@ -169,7 +171,7 @@ with each doublet being a comma-separated set of style name and table of content
|
||||
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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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>
|
||||
@ -179,14 +181,14 @@ where startLevel and endLevel are integers, and startLevel has a value equal-to
|
||||
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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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/d508e8a/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>
|
||||
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/568c764/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">
|
||||
|
Reference in New Issue
Block a user