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

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

183
api/classes/headerwrapper.html
View File

@ -93,13 +93,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="headerwrapper.html#add" class="tsd-kind-icon">add</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="headerwrapper.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="headerwrapper.html#addimage" class="tsd-kind-icon">add<wbr>Image</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="headerwrapper.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="headerwrapper.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="headerwrapper.html#createimage" class="tsd-kind-icon">create<wbr>Image</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="headerwrapper.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="headerwrapper.html#createtable" class="tsd-kind-icon">create<wbr>Table</a></li>
</ul>
</section>
</div>
@ -117,7 +113,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/header-wrapper.ts#L17">file/header-wrapper.ts:17</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/header-wrapper.ts#L17">file/header-wrapper.ts:17</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -149,7 +145,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/header-wrapper.ts#L56">file/header-wrapper.ts:56</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/header-wrapper.ts#L39">file/header-wrapper.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="header.html" class="tsd-signature-type">Header</a></h4>
@ -166,7 +162,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/header-wrapper.ts#L64">file/header-wrapper.ts:64</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/header-wrapper.ts#L47">file/header-wrapper.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="media.html" class="tsd-signature-type">Media</a></h4>
@ -183,7 +179,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/header-wrapper.ts#L60">file/header-wrapper.ts:60</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/header-wrapper.ts#L43">file/header-wrapper.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="relationships.html" class="tsd-signature-type">Relationships</a></h4>
@ -193,6 +189,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><span class="tsd-signature-symbol">: </span><a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</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/header-wrapper.ts#L24">file/header-wrapper.ts:24</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></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addchildelement" class="tsd-anchor"></a>
<h3>add<wbr>Child<wbr>Element</h3>
@ -203,7 +222,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/header-wrapper.ts#L42">file/header-wrapper.ts:42</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/header-wrapper.ts#L35">file/header-wrapper.ts:35</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -226,7 +245,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/header-wrapper.ts#L51">file/header-wrapper.ts:51</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/629e6a5/src/file/header-wrapper.ts#L30">file/header-wrapper.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -239,130 +258,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><span class="tsd-signature-type">void</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/header-wrapper.ts#L24">file/header-wrapper.ts:24</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 <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="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><span class="tsd-signature-type">void</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/header-wrapper.ts#L34">file/header-wrapper.ts:34</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 <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="createimage" class="tsd-anchor"></a>
<h3>create<wbr>Image</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">create<wbr>Image<span class="tsd-signature-symbol">(</span>image<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span>, width<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/header-wrapper.ts#L46">file/header-wrapper.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>image: <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> width: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> height: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<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="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/header-wrapper.ts#L28">file/header-wrapper.ts:28</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>rows<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, cols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><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/header-wrapper.ts#L38">file/header-wrapper.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>rows: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>cols: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="table.html" class="tsd-signature-type">Table</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@ -392,27 +287,15 @@
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
<a href="headerwrapper.html#relationships" class="tsd-kind-icon">Relationships</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="headerwrapper.html#add" class="tsd-kind-icon">add</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="headerwrapper.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="headerwrapper.html#addimage" class="tsd-kind-icon">add<wbr>Image</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="headerwrapper.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="headerwrapper.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="headerwrapper.html#createimage" class="tsd-kind-icon">create<wbr>Image</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="headerwrapper.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="headerwrapper.html#createtable" class="tsd-kind-icon">create<wbr>Table</a>
</li>
</ul>
</li>
</ul>