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 11:53:05 +00:00
parent daa73592d7
commit d0304ec718
396 changed files with 5554 additions and 2842 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
api/classes/textrun.html
View File

@ -104,11 +104,13 @@
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="textrun.html#delete" class="tsd-kind-icon">delete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="textrun.html#doublestrike" class="tsd-kind-icon">double<wbr>Strike</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="textrun.html#font" class="tsd-kind-icon">font</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="textrun.html#highlight" class="tsd-kind-icon">highlight</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="textrun.html#italics" class="tsd-kind-icon">italics</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="textrun.html#numberoftotalpages" class="tsd-kind-icon">number<wbr>OfTotal<wbr>Pages</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="textrun.html#pagenumber" class="tsd-kind-icon">page<wbr>Number</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="textrun.html#prepforxml" class="tsd-kind-icon">prep<wbr>For<wbr>Xml</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="textrun.html#righttoleft" class="tsd-kind-icon">right<wbr>ToLeft</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="textrun.html#shadow" class="tsd-kind-icon">shadow</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="textrun.html#size" class="tsd-kind-icon">size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="textrun.html#smallcaps" class="tsd-kind-icon">small<wbr>Caps</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="textrun.html#strike" class="tsd-kind-icon">strike</a></li>
@ -135,7 +137,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="run.html">Run</a>.<a href="run.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/text-run.ts#L4">file/paragraph/run/text-run.ts:4</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/text-run.ts#L4">file/paragraph/run/text-run.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -162,7 +164,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/3263984/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/2a5e372/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>
@ -183,7 +185,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/3263984/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/2a5e372/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>
@ -207,7 +209,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#allcaps">allCaps</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L100">file/paragraph/run/run.ts:100</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L104">file/paragraph/run/run.ts:104</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
@ -225,7 +227,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#bold">bold</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L36">file/paragraph/run/run.ts:36</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L40">file/paragraph/run/run.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
@ -243,7 +245,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#break">break</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L69">file/paragraph/run/run.ts:69</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L73">file/paragraph/run/run.ts:73</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
@ -261,7 +263,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#color">color</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L53">file/paragraph/run/run.ts:53</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L57">file/paragraph/run/run.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -285,7 +287,7 @@
<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/3263984/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/2a5e372/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>
@ -303,7 +305,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#doublestrike">doubleStrike</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L110">file/paragraph/run/run.ts:110</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L114">file/paragraph/run/run.ts:114</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
@ -321,7 +323,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#font">font</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L125">file/paragraph/run/run.ts:125</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L129">file/paragraph/run/run.ts:129</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -337,6 +339,30 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="highlight" class="tsd-anchor"></a>
<h3>highlight</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">highlight<span class="tsd-signature-symbol">(</span>color<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="run.html" class="tsd-signature-type">Run</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#highlight">highlight</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L139">file/paragraph/run/run.ts:139</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>color: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</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="italics" class="tsd-anchor"></a>
<h3>italics</h3>
@ -348,7 +374,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#italics">italics</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L42">file/paragraph/run/run.ts:42</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L46">file/paragraph/run/run.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
@ -366,7 +392,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#numberoftotalpages">numberOfTotalPages</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L87">file/paragraph/run/run.ts:87</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L91">file/paragraph/run/run.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
@ -384,7 +410,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#pagenumber">pageNumber</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L79">file/paragraph/run/run.ts:79</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L83">file/paragraph/run/run.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
@ -403,7 +429,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/3263984/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/2a5e372/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>
@ -424,13 +450,43 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#righttoleft">rightToLeft</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L64">file/paragraph/run/run.ts:64</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L68">file/paragraph/run/run.ts:68</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</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="shadow" class="tsd-anchor"></a>
<h3>shadow</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">shadow<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fill<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, color<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="run.html" class="tsd-signature-type">Run</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#shadow">shadow</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L145">file/paragraph/run/run.ts:145</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>fill: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>color: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</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="size" class="tsd-anchor"></a>
<h3>size</h3>
@ -442,7 +498,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#size">size</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L58">file/paragraph/run/run.ts:58</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L62">file/paragraph/run/run.ts:62</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -466,7 +522,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#smallcaps">smallCaps</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L95">file/paragraph/run/run.ts:95</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L99">file/paragraph/run/run.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
@ -484,7 +540,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#strike">strike</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L105">file/paragraph/run/run.ts:105</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L109">file/paragraph/run/run.ts:109</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
@ -502,7 +558,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#style">style</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L130">file/paragraph/run/run.ts:130</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L134">file/paragraph/run/run.ts:134</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -526,7 +582,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#subscript">subScript</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L115">file/paragraph/run/run.ts:115</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L119">file/paragraph/run/run.ts:119</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
@ -544,7 +600,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#superscript">superScript</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L120">file/paragraph/run/run.ts:120</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L124">file/paragraph/run/run.ts:124</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
@ -562,7 +618,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#tab">tab</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L74">file/paragraph/run/run.ts:74</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L78">file/paragraph/run/run.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="run.html" class="tsd-signature-type">Run</a></h4>
@ -580,7 +636,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="run.html">Run</a>.<a href="run.html#underline">underline</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/paragraph/run/run.ts#L48">file/paragraph/run/run.ts:48</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/paragraph/run/run.ts#L52">file/paragraph/run/run.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -643,6 +699,9 @@
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="textrun.html#font" class="tsd-kind-icon">font</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="textrun.html#highlight" class="tsd-kind-icon">highlight</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="textrun.html#italics" class="tsd-kind-icon">italics</a>
</li>
@ -658,6 +717,9 @@
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="textrun.html#righttoleft" class="tsd-kind-icon">right<wbr>ToLeft</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="textrun.html#shadow" class="tsd-kind-icon">shadow</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="textrun.html#size" class="tsd-kind-icon">size</a>
</li>