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

94
api/classes/hyperlinkstyle.html
View File

@ -102,11 +102,13 @@
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="hyperlinkstyle.html#bold" class="tsd-kind-icon">bold</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="hyperlinkstyle.html#color" class="tsd-kind-icon">color</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="hyperlinkstyle.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="hyperlinkstyle.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="hyperlinkstyle.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="hyperlinkstyle.html#link" class="tsd-kind-icon">link</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="hyperlinkstyle.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="hyperlinkstyle.html#push" class="tsd-kind-icon">push</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="hyperlinkstyle.html#semihidden" class="tsd-kind-icon">semi<wbr>Hidden</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="hyperlinkstyle.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="hyperlinkstyle.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="hyperlinkstyle.html#superscript" class="tsd-kind-icon">super<wbr>Script</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="hyperlinkstyle.html#underline" class="tsd-kind-icon">underline</a></li>
@ -128,7 +130,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/styles/style/default-styles.ts#L99">file/styles/style/default-styles.ts:99</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/default-styles.ts#L99">file/styles/style/default-styles.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="hyperlinkstyle.html" class="tsd-signature-type">HyperlinkStyle</a></h4>
@ -149,7 +151,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>
@ -170,7 +172,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>
@ -194,7 +196,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#addrunproperty">addRunProperty</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/styles/style/character-style.ts#L23">file/styles/style/character-style.ts:23</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/character-style.ts#L23">file/styles/style/character-style.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -218,7 +220,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#basedon">basedOn</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/styles/style/character-style.ts#L18">file/styles/style/character-style.ts:18</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/character-style.ts#L18">file/styles/style/character-style.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -242,7 +244,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#bold">bold</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/styles/style/character-style.ts#L32">file/styles/style/character-style.ts:32</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/character-style.ts#L32">file/styles/style/character-style.ts:32</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="characterstyle.html" class="tsd-signature-type">CharacterStyle</a></h4>
@ -260,7 +262,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#color">color</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/styles/style/character-style.ts#L28">file/styles/style/character-style.ts:28</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/character-style.ts#L28">file/styles/style/character-style.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -284,13 +286,37 @@
<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>
</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="characterstyle.html" class="tsd-signature-type">CharacterStyle</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#highlight">highlight</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/character-style.ts#L62">file/styles/style/character-style.ts:62</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="characterstyle.html" class="tsd-signature-type">CharacterStyle</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>
@ -302,7 +328,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#italics">italics</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/styles/style/character-style.ts#L36">file/styles/style/character-style.ts:36</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/character-style.ts#L36">file/styles/style/character-style.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="characterstyle.html" class="tsd-signature-type">CharacterStyle</a></h4>
@ -320,7 +346,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#link">link</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/styles/style/character-style.ts#L52">file/styles/style/character-style.ts:52</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/character-style.ts#L52">file/styles/style/character-style.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -345,7 +371,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>
@ -366,7 +392,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="style.html">Style</a>.<a href="style.html#push">push</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/styles/style/style.ts#L29">file/styles/style/style.ts:29</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/style.ts#L29">file/styles/style/style.ts:29</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -390,13 +416,43 @@
<aside class="tsd-sources">
<p>Inherited from <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#semihidden">semiHidden</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/styles/style/character-style.ts#L57">file/styles/style/character-style.ts:57</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/character-style.ts#L57">file/styles/style/character-style.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="characterstyle.html" class="tsd-signature-type">CharacterStyle</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="characterstyle.html" class="tsd-signature-type">CharacterStyle</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#shadow">shadow</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/character-style.ts#L66">file/styles/style/character-style.ts:66</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="characterstyle.html" class="tsd-signature-type">CharacterStyle</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>
@ -408,7 +464,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#size">size</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/styles/style/character-style.ts#L48">file/styles/style/character-style.ts:48</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/character-style.ts#L48">file/styles/style/character-style.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -432,7 +488,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#superscript">superScript</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/styles/style/character-style.ts#L44">file/styles/style/character-style.ts:44</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/character-style.ts#L44">file/styles/style/character-style.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="characterstyle.html" class="tsd-signature-type">CharacterStyle</a></h4>
@ -450,7 +506,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="characterstyle.html">CharacterStyle</a>.<a href="characterstyle.html#underline">underline</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3263984/src/file/styles/style/character-style.ts#L40">file/styles/style/character-style.ts:40</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2a5e372/src/file/styles/style/character-style.ts#L40">file/styles/style/character-style.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -507,6 +563,9 @@
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="hyperlinkstyle.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="hyperlinkstyle.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="hyperlinkstyle.html#italics" class="tsd-kind-icon">italics</a>
</li>
@ -522,6 +581,9 @@
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="hyperlinkstyle.html#semihidden" class="tsd-kind-icon">semi<wbr>Hidden</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="hyperlinkstyle.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="hyperlinkstyle.html#size" class="tsd-kind-icon">size</a>
</li>