Deploy dolanmiu/docx to github.com/dolanmiu/docx.git:gh-pages

This commit is contained in:
Deployment Bot (from Travis CI)
2020-07-18 02:02:15 +00:00
parent a5290f137f
commit 7d84d33bc9
436 changed files with 4229 additions and 6896 deletions

View File

@ -64,17 +64,6 @@
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</div>
<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">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
@ -119,16 +108,9 @@
<div class="tsd-signature tsd-kind-icon">caption<wbr>Label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L25">file/table-of-contents/table-of-contents-properties.ts:25</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>\a option - Includes captioned items, but omits caption labels and numbers.
The identifier designated by text in this switch&#39;s field-argument corresponds to the caption label.
Use captionLabelIncludingNumbers (\c) to build a table of captions with labels and numbers.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="captionlabelincludingnumbers" class="tsd-anchor"></a>
@ -136,17 +118,9 @@
<div class="tsd-signature tsd-kind-icon">caption<wbr>Label<wbr>Including<wbr>Numbers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L39">file/table-of-contents/table-of-contents-properties.ts:39</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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&#39;s
field-argument, which corresponds to the caption label, shall match the identifier in the
corresponding SEQ field.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="entriesfrombookmark" class="tsd-anchor"></a>
@ -154,15 +128,9 @@
<div class="tsd-signature tsd-kind-icon">entries<wbr>From<wbr>Bookmark<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L31">file/table-of-contents/table-of-contents-properties.ts:31</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>\b option - Includes entries only from the portion of the document marked by
the bookmark named by text in this switch&#39;s field-argument.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="entryandpagenumberseparator" class="tsd-anchor"></a>
@ -170,15 +138,9 @@
<div class="tsd-signature tsd-kind-icon">entry<wbr>And<wbr>Page<wbr>Number<wbr>Separator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L86">file/table-of-contents/table-of-contents-properties.ts:86</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>\p option - Text in this switch&#39;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>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="headingstylerange" class="tsd-anchor"></a>
@ -186,18 +148,9 @@
<div class="tsd-signature tsd-kind-icon">heading<wbr>Style<wbr>Range<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L80">file/table-of-contents/table-of-contents-properties.ts:80</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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&#39;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>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="hidetabandpagenumbersinwebview" class="tsd-anchor"></a>
@ -205,14 +158,9 @@
<div class="tsd-signature tsd-kind-icon">hide<wbr>Tab<wbr>And<wbr>Page<wbr>Numbers<wbr>InWeb<wbr>View<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L121">file/table-of-contents/table-of-contents-properties.ts:121</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>\z Hides tab leader and page numbers in web page view (§17.18.102).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="hyperlink" class="tsd-anchor"></a>
@ -220,14 +168,9 @@
<div class="tsd-signature tsd-kind-icon">hyperlink<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L56">file/table-of-contents/table-of-contents-properties.ts:56</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>\h option - Makes the table of contents entries hyperlinks.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="pagenumbersentrylevelsrange" class="tsd-anchor"></a>
@ -235,16 +178,9 @@
<div class="tsd-signature tsd-kind-icon">page<wbr>Numbers<wbr>Entry<wbr>Levels<wbr>Range<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L71">file/table-of-contents/table-of-contents-properties.ts:71</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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&#39;s field-argument. A range is specified as for \l.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="preservenewlineinentries" class="tsd-anchor"></a>
@ -252,14 +188,9 @@
<div class="tsd-signature tsd-kind-icon">preserve<wbr>New<wbr>Line<wbr>InEntries<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L116">file/table-of-contents/table-of-contents-properties.ts:116</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>\x Preserves newline characters within table entries.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="preservetabinentries" class="tsd-anchor"></a>
@ -267,14 +198,9 @@
<div class="tsd-signature tsd-kind-icon">preserve<wbr>Tab<wbr>InEntries<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L111">file/table-of-contents/table-of-contents-properties.ts:111</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>\w Preserves tab entries within table entries.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="seqfieldidentifierforprefix" class="tsd-anchor"></a>
@ -282,16 +208,9 @@
<div class="tsd-signature tsd-kind-icon">seq<wbr>Field<wbr>Identifier<wbr>For<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L93">file/table-of-contents/table-of-contents-properties.ts:93</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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&#39;s field-argument shall match the
identifier in the SEQ field.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="sequenceandpagenumbersseparator" class="tsd-anchor"></a>
@ -299,15 +218,9 @@
<div class="tsd-signature tsd-kind-icon">sequence<wbr>And<wbr>Page<wbr>Numbers<wbr>Separator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L45">file/table-of-contents/table-of-contents-properties.ts:45</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>\d option - When used with \s, the text in this switch&#39;s field-argument defines
the separator between sequence and page numbers. The default separator is a hyphen (-).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="styleswithlevels" class="tsd-anchor"></a>
@ -315,17 +228,9 @@
<div class="tsd-signature tsd-kind-icon">styles<wbr>With<wbr>Levels<span class="tsd-signature-symbol">:</span> <a href="../classes/stylelevel.html" class="tsd-signature-type">StyleLevel</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L101">file/table-of-contents/table-of-contents-properties.ts:101</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>\t field-argument Uses paragraphs formatted with styles other than the built-in heading styles.
Text in this switch&#39;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>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="tcfieldidentifier" class="tsd-anchor"></a>
@ -333,15 +238,9 @@
<div class="tsd-signature tsd-kind-icon">tc<wbr>Field<wbr>Identifier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L51">file/table-of-contents/table-of-contents-properties.ts:51</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>\f option - Includes only those TC fields whose identifier exactly matches the
text in this switch&#39;s field-argument (which is typically a letter).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="tcfieldlevelrange" class="tsd-anchor"></a>
@ -349,17 +248,9 @@
<div class="tsd-signature tsd-kind-icon">tc<wbr>Field<wbr>Level<wbr>Range<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L64">file/table-of-contents/table-of-contents-properties.ts:64</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>\l option - Includes TC fields that assign entries to one of the levels specified
by text in this switch&#39;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>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="useappliedparagraphoutlinelevel" class="tsd-anchor"></a>
@ -367,14 +258,9 @@
<div class="tsd-signature tsd-kind-icon">use<wbr>Applied<wbr>Paragraph<wbr>Outline<wbr>Level<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/e632d32/src/file/table-of-contents/table-of-contents-properties.ts#L106">file/table-of-contents/table-of-contents-properties.ts:106</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6a3ed4b/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>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>\u Uses the applied paragraph outline level.</p>
</div>
</div>
</section>
</section>
</div>