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)
2018-10-22 23:50:33 +00:00
parent 446ad9051a
commit 17ca0fe4e1
354 changed files with 6514 additions and 2991 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
api/classes/headerwrapper.html
View File

@ -86,6 +86,7 @@
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="headerwrapper.html#header" class="tsd-kind-icon">Header</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="headerwrapper.html#media" class="tsd-kind-icon">Media</a></li>
<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>
</ul>
</section>
@ -93,7 +94,9 @@
<h3>Methods</h3>
<ul class="tsd-index-list">
<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#addhyperlinkrelationship" class="tsd-kind-icon">add<wbr>Hyperlink<wbr>Relationship</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#addimagerelationship" class="tsd-kind-icon">add<wbr>Image<wbr>Relationship</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>
@ -110,13 +113,13 @@
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">new <wbr>Header<wbr>Wrapper<span class="tsd-signature-symbol">(</span>media<span class="tsd-signature-symbol">: </span><a href="media.html" class="tsd-signature-type">Media</a>, referenceId<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="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Header<wbr>Wrapper<span class="tsd-signature-symbol">(</span>media<span class="tsd-signature-symbol">: </span><a href="media.html" class="tsd-signature-type">Media</a>, referenceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, initContent<span class="tsd-signature-symbol">?: </span><a href="xmlcomponent.html" class="tsd-signature-type">XmlComponent</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/3f80b05/src/file/header-wrapper.ts#L10">file/header-wrapper.ts:10</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/1eed844/src/file/header-wrapper.ts#L17">file/header-wrapper.ts:17</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -127,6 +130,9 @@
<li>
<h5>referenceId: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initContent: <a href="xmlcomponent.html" class="tsd-signature-type">XmlComponent</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a></h4>
</li>
@ -145,13 +151,30 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3f80b05/src/file/header-wrapper.ts#L54">file/header-wrapper.ts:54</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/1eed844/src/file/header-wrapper.ts#L77">file/header-wrapper.ts:77</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="header.html" class="tsd-signature-type">Header</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
<a name="media" class="tsd-anchor"></a>
<h3>Media</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Media<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="media.html" class="tsd-signature-type">Media</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/1eed844/src/file/header-wrapper.ts#L85">file/header-wrapper.ts:85</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="media.html" class="tsd-signature-type">Media</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
<a name="relationships" class="tsd-anchor"></a>
<h3>Relationships</h3>
@ -162,7 +185,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3f80b05/src/file/header-wrapper.ts#L58">file/header-wrapper.ts:58</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/1eed844/src/file/header-wrapper.ts#L81">file/header-wrapper.ts:81</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="relationships.html" class="tsd-signature-type">Relationships</a></h4>
@ -182,7 +205,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3f80b05/src/file/header-wrapper.ts#L35">file/header-wrapper.ts:35</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/1eed844/src/file/header-wrapper.ts#L42">file/header-wrapper.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -195,6 +218,35 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addhyperlinkrelationship" class="tsd-anchor"></a>
<h3>add<wbr>Hyperlink<wbr>Relationship</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Hyperlink<wbr>Relationship<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, refId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, targetMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"External"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</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/1eed844/src/file/header-wrapper.ts#L56">file/header-wrapper.ts:56</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>target: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>refId: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> targetMode: <span class="tsd-signature-type">"External"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</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="addimage" class="tsd-anchor"></a>
<h3>add<wbr>Image</h3>
@ -205,7 +257,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3f80b05/src/file/header-wrapper.ts#L49">file/header-wrapper.ts:49</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/1eed844/src/file/header-wrapper.ts#L72">file/header-wrapper.ts:72</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -218,6 +270,38 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addimagerelationship" class="tsd-anchor"></a>
<h3>add<wbr>Image<wbr>Relationship</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Image<wbr>Relationship<span class="tsd-signature-symbol">(</span>image<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, refId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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><a href="../interfaces/imediadata.html" class="tsd-signature-type">IMediaData</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/1eed844/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></h5>
</li>
<li>
<h5>refId: <span class="tsd-signature-type">number</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 <a href="../interfaces/imediadata.html" class="tsd-signature-type">IMediaData</a></h4>
</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>
@ -228,7 +312,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3f80b05/src/file/header-wrapper.ts#L17">file/header-wrapper.ts:17</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/1eed844/src/file/header-wrapper.ts#L24">file/header-wrapper.ts:24</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -251,7 +335,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3f80b05/src/file/header-wrapper.ts#L27">file/header-wrapper.ts:27</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/1eed844/src/file/header-wrapper.ts#L34">file/header-wrapper.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -268,19 +352,19 @@
<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>, 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>
<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/3f80b05/src/file/header-wrapper.ts#L39">file/header-wrapper.ts:39</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/1eed844/src/file/header-wrapper.ts#L65">file/header-wrapper.ts:65</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></h5>
<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>
@ -303,7 +387,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3f80b05/src/file/header-wrapper.ts#L21">file/header-wrapper.ts:21</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/1eed844/src/file/header-wrapper.ts#L28">file/header-wrapper.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -326,7 +410,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3f80b05/src/file/header-wrapper.ts#L31">file/header-wrapper.ts:31</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/1eed844/src/file/header-wrapper.ts#L38">file/header-wrapper.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -365,15 +449,24 @@
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
<a href="headerwrapper.html#header" class="tsd-kind-icon">Header</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
<a href="headerwrapper.html#media" class="tsd-kind-icon">Media</a>
</li>
<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#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#addhyperlinkrelationship" class="tsd-kind-icon">add<wbr>Hyperlink<wbr>Relationship</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#addimagerelationship" class="tsd-kind-icon">add<wbr>Image<wbr>Relationship</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>