smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ dolanmiu/docx@7e2538dffc 🚀

Browse Source
This commit is contained in:
dolanmiu
2023-12-25 02:49:57 +00:00
parent c4f13c5218
commit b4672bf3ba
367 changed files with 1572 additions and 1572 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
api/interfaces/ITableOfContentsOptions.html
View File

@ -28,7 +28,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/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L19">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L19">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">
@ -64,7 +64,7 @@ Use captionLabelIncludingNumbers (\c) to build a table of captions with labels a
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L25">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L25">file/table-of-contents/table-of-contents-properties.ts:25</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">caption<wbr/>Label<wbr/>Including<wbr/>Numbers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@ -75,7 +75,7 @@ corresponding SEQ field.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L39">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L39">file/table-of-contents/table-of-contents-properties.ts:39</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">entries<wbr/>From<wbr/>Bookmark</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@ -84,7 +84,7 @@ the bookmark named by text in this switch&#39;s field-argument.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L31">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L31">file/table-of-contents/table-of-contents-properties.ts:31</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">entry<wbr/>And<wbr/>Page<wbr/>Number<wbr/>Separator</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@ -93,7 +93,7 @@ that separate an entry and its page number. The default is a tab with leader dot
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L86">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L86">file/table-of-contents/table-of-contents-properties.ts:86</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">heading<wbr/>Style<wbr/>Range</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@ -105,7 +105,7 @@ If no heading range is specified, all heading levels used in the document are li
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L80">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L80">file/table-of-contents/table-of-contents-properties.ts:80</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">hide<wbr/>Tab<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>In<wbr/>Web<wbr/>View</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@ -113,7 +113,7 @@ If no heading range is specified, all heading levels used in the document are li
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L121">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L121">file/table-of-contents/table-of-contents-properties.ts:121</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">hyperlink</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@ -121,7 +121,7 @@ If no heading range is specified, all heading levels used in the document are li
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L56">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L56">file/table-of-contents/table-of-contents-properties.ts:56</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">page<wbr/>Numbers<wbr/>Entry<wbr/>Levels<wbr/>Range</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@ -131,7 +131,7 @@ text in this switch&#39;s field-argument. A range is specified as for \l.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L71">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L71">file/table-of-contents/table-of-contents-properties.ts:71</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">preserve<wbr/>New<wbr/>Line<wbr/>In<wbr/>Entries</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@ -139,7 +139,7 @@ text in this switch&#39;s field-argument. A range is specified as for \l.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L116">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L116">file/table-of-contents/table-of-contents-properties.ts:116</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">preserve<wbr/>Tab<wbr/>In<wbr/>Entries</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@ -147,7 +147,7 @@ text in this switch&#39;s field-argument. A range is specified as for \l.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L111">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L111">file/table-of-contents/table-of-contents-properties.ts:111</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">seq<wbr/>Field<wbr/>Identifier<wbr/>For<wbr/>Prefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@ -157,7 +157,7 @@ identifier in the SEQ field.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L93">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L93">file/table-of-contents/table-of-contents-properties.ts:93</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">sequence<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>Separator</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@ -166,7 +166,7 @@ the separator between sequence and page numbers. The default separator is a hyph
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L45">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L45">file/table-of-contents/table-of-contents-properties.ts:45</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">styles<wbr/>With<wbr/>Levels</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">readonly </span><a href="../classes/StyleLevel.html" class="tsd-signature-type tsd-kind-class">StyleLevel</a><span class="tsd-signature-symbol">[]</span></div>
@ -177,7 +177,7 @@ with each doublet being a comma-separated set of style name and table of content
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L101">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L101">file/table-of-contents/table-of-contents-properties.ts:101</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">tc<wbr/>Field<wbr/>Identifier</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@ -186,7 +186,7 @@ text in this switch&#39;s field-argument (which is typically a letter).</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L51">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L51">file/table-of-contents/table-of-contents-properties.ts:51</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">tc<wbr/>Field<wbr/>Level<wbr/>Range</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@ -197,7 +197,7 @@ TC fields that assign entries to lower levels are skipped.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L64">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L64">file/table-of-contents/table-of-contents-properties.ts:64</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">use<wbr/>Applied<wbr/>Paragraph<wbr/>Outline<wbr/>Level</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@ -205,7 +205,7 @@ TC fields that assign entries to lower levels are skipped.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/table-of-contents/table-of-contents-properties.ts#L106">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/7e2538d/src/file/table-of-contents/table-of-contents-properties.ts#L106">file/table-of-contents/table-of-contents-properties.ts:106</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">