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

This commit is contained in:
Deployment Bot (from Travis CI)
2019-08-06 22:40:09 +00:00
parent d0304ec718
commit 91170899c7
424 changed files with 7127 additions and 9994 deletions

View File

@ -97,14 +97,9 @@
<section class="tsd-index-section tsd-is-external">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="document.html#add" class="tsd-kind-icon">add</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="document.html#addchildelement" class="tsd-kind-icon">add<wbr>Child<wbr>Element</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="document.html#addparagraph" class="tsd-kind-icon">add<wbr>Paragraph</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="document.html#addtable" class="tsd-kind-icon">add<wbr>Table</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="document.html#addtableofcontents" class="tsd-kind-icon">add<wbr>Table<wbr>OfContents</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="document.html#createparagraph" class="tsd-kind-icon">create<wbr>Paragraph</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="document.html#createtable" class="tsd-kind-icon">create<wbr>Table</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="document.html#delete" class="tsd-kind-icon">delete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="document.html#getparagraphs" class="tsd-kind-icon">get<wbr>Paragraphs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="document.html#gettablesofcontents" class="tsd-kind-icon">get<wbr>Tables<wbr>OfContents</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="document.html#prepforxml" class="tsd-kind-icon">prep<wbr>For<wbr>Xml</a></li>
</ul>
@ -118,22 +113,16 @@
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<li class="tsd-signature tsd-kind-icon">new <wbr>Document<span class="tsd-signature-symbol">(</span>sectionPropertiesOptions<span class="tsd-signature-symbol">?: </span><a href="../globals.html#sectionpropertiesoptions" class="tsd-signature-type">SectionPropertiesOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="document.html" class="tsd-signature-type">Document</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Document<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="document.html" class="tsd-signature-type">Document</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="xmlcomponent.html">XmlComponent</a>.<a href="xmlcomponent.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/document/document.ts#L11">file/document/document.ts:11</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/document/document.ts#L10">file/document/document.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> sectionPropertiesOptions: <a href="../globals.html#sectionpropertiesoptions" class="tsd-signature-type">SectionPropertiesOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="document.html" class="tsd-signature-type">Document</a></h4>
</li>
</ul>
@ -151,7 +140,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/document/document.ts#L67">file/document/document.ts:67</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/document/document.ts#L44">file/document/document.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="body.html" class="tsd-signature-type">Body</a></h4>
@ -169,7 +158,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="basexmlcomponent.html">BaseXmlComponent</a>.<a href="basexmlcomponent.html#isdeleted">IsDeleted</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/xml-components/base.ts#L14">file/xml-components/base.ts:14</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/xml-components/base.ts#L14">file/xml-components/base.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
@ -179,6 +168,29 @@
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="add" class="tsd-anchor"></a>
<h3>add</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><a href="paragraph.html" class="tsd-signature-type">Paragraph</a><span class="tsd-signature-symbol"> | </span><a href="table.html" class="tsd-signature-type">Table</a><span class="tsd-signature-symbol"> | </span><a href="tableofcontents.html" class="tsd-signature-type">TableOfContents</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="document.html" class="tsd-signature-type">Document</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/document/document.ts#L39">file/document/document.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>item: <a href="paragraph.html" class="tsd-signature-type">Paragraph</a><span class="tsd-signature-symbol"> | </span><a href="table.html" class="tsd-signature-type">Table</a><span class="tsd-signature-symbol"> | </span><a href="tableofcontents.html" class="tsd-signature-type">TableOfContents</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="document.html" class="tsd-signature-type">Document</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="addchildelement" class="tsd-anchor"></a>
<h3>add<wbr>Child<wbr>Element</h3>
@ -190,7 +202,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="xmlcomponent.html">XmlComponent</a>.<a href="xmlcomponent.html#addchildelement">addChildElement</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/xml-components/xml-component.ts#L43">file/xml-components/xml-component.ts:43</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/xml-components/xml-component.ts#L43">file/xml-components/xml-component.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -203,121 +215,6 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addparagraph" class="tsd-anchor"></a>
<h3>add<wbr>Paragraph</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Paragraph<span class="tsd-signature-symbol">(</span>paragraph<span class="tsd-signature-symbol">: </span><a href="paragraph.html" class="tsd-signature-type">Paragraph</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="document.html" class="tsd-signature-type">Document</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/document/document.ts#L40">file/document/document.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paragraph: <a href="paragraph.html" class="tsd-signature-type">Paragraph</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="document.html" class="tsd-signature-type">Document</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addtable" class="tsd-anchor"></a>
<h3>add<wbr>Table</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Table<span class="tsd-signature-symbol">(</span>table<span class="tsd-signature-symbol">: </span><a href="table.html" class="tsd-signature-type">Table</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="document.html" class="tsd-signature-type">Document</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/document/document.ts#L56">file/document/document.ts:56</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>table: <a href="table.html" class="tsd-signature-type">Table</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="document.html" class="tsd-signature-type">Document</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addtableofcontents" class="tsd-anchor"></a>
<h3>add<wbr>Table<wbr>OfContents</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Table<wbr>OfContents<span class="tsd-signature-symbol">(</span>toc<span class="tsd-signature-symbol">: </span><a href="tableofcontents.html" class="tsd-signature-type">TableOfContents</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="document.html" class="tsd-signature-type">Document</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/document/document.ts#L45">file/document/document.ts:45</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>toc: <a href="tableofcontents.html" class="tsd-signature-type">TableOfContents</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="document.html" class="tsd-signature-type">Document</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="createparagraph" class="tsd-anchor"></a>
<h3>create<wbr>Paragraph</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">create<wbr>Paragraph<span class="tsd-signature-symbol">(</span>text<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="paragraph.html" class="tsd-signature-type">Paragraph</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/document/document.ts#L50">file/document/document.ts:50</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> text: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="paragraph.html" class="tsd-signature-type">Paragraph</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="createtable" class="tsd-anchor"></a>
<h3>create<wbr>Table</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">create<wbr>Table<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/itableoptions.html" class="tsd-signature-type">ITableOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="table.html" class="tsd-signature-type">Table</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/document/document.ts#L61">file/document/document.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="../interfaces/itableoptions.html" class="tsd-signature-type">ITableOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="table.html" class="tsd-signature-type">Table</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="delete" class="tsd-anchor"></a>
<h3>delete</h3>
@ -329,30 +226,13 @@
<aside class="tsd-sources">
<p>Inherited from <a href="xmlcomponent.html">XmlComponent</a>.<a href="xmlcomponent.html#delete">delete</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/xml-components/xml-component.ts#L49">file/xml-components/xml-component.ts:49</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/xml-components/xml-component.ts#L49">file/xml-components/xml-component.ts:49</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="getparagraphs" class="tsd-anchor"></a>
<h3>get<wbr>Paragraphs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get<wbr>Paragraphs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="paragraph.html" class="tsd-signature-type">Paragraph</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/document/document.ts#L75">file/document/document.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="paragraph.html" class="tsd-signature-type">Paragraph</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="gettablesofcontents" class="tsd-anchor"></a>
<h3>get<wbr>Tables<wbr>OfContents</h3>
@ -363,7 +243,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/document/document.ts#L71">file/document/document.ts:71</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/document/document.ts#L48">file/document/document.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="tableofcontents.html" class="tsd-signature-type">TableOfContents</a><span class="tsd-signature-symbol">[]</span></h4>
@ -382,7 +262,7 @@
<p>Inherited from <a href="xmlcomponent.html">XmlComponent</a>.<a href="xmlcomponent.html#prepforxml">prepForXml</a></p>
<p>Overrides <a href="basexmlcomponent.html">BaseXmlComponent</a>.<a href="basexmlcomponent.html#prepforxml">prepForXml</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/xml-components/xml-component.ts#L16">file/xml-components/xml-component.ts:16</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/xml-components/xml-component.ts#L16">file/xml-components/xml-component.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ixmlableobject.html" class="tsd-signature-type">IXmlableObject</a>
@ -418,30 +298,15 @@
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="document.html#isdeleted" class="tsd-kind-icon">Is<wbr>Deleted</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="document.html#add" class="tsd-kind-icon">add</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="document.html#addchildelement" class="tsd-kind-icon">add<wbr>Child<wbr>Element</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="document.html#addparagraph" class="tsd-kind-icon">add<wbr>Paragraph</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="document.html#addtable" class="tsd-kind-icon">add<wbr>Table</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="document.html#addtableofcontents" class="tsd-kind-icon">add<wbr>Table<wbr>OfContents</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="document.html#createparagraph" class="tsd-kind-icon">create<wbr>Paragraph</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="document.html#createtable" class="tsd-kind-icon">create<wbr>Table</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="document.html#delete" class="tsd-kind-icon">delete</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="document.html#getparagraphs" class="tsd-kind-icon">get<wbr>Paragraphs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="document.html#gettablesofcontents" class="tsd-kind-icon">get<wbr>Tables<wbr>OfContents</a>
</li>