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

This commit is contained in:
Deployment Bot (from Travis CI)
2018-12-07 15:42:13 +00:00
parent 91e1ed58b8
commit ee88507749
369 changed files with 4159 additions and 2601 deletions

View File

@ -68,7 +68,7 @@
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">Style</span>
<a href="characterstyle.html" class="tsd-signature-type">CharacterStyle</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">FootnoteReferenceStyle</span>
@ -97,9 +97,17 @@
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="footnotereferencestyle.html#addchildelement" class="tsd-kind-icon">add<wbr>Child<wbr>Element</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="footnotereferencestyle.html#addrunproperty" class="tsd-kind-icon">add<wbr>Run<wbr>Property</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="footnotereferencestyle.html#basedon" class="tsd-kind-icon">based<wbr>On</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.html#underline" class="tsd-kind-icon">underline</a></li>
</ul>
</section>
</div>
@ -116,9 +124,9 @@
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides Style.__constructor</p>
<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/600f97d/src/file/styles/style/index.ts#L292">file/styles/style/index.ts:292</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/src/file/styles/style/default-styles.ts#L80">file/styles/style/default-styles.ts:80</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="footnotereferencestyle.html" class="tsd-signature-type">FootnoteReferenceStyle</a></h4>
@ -139,7 +147,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/600f97d/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/bf18154/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>
@ -160,7 +168,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/600f97d/src/file/xml-components/xml-component.ts#L34">file/xml-components/xml-component.ts:34</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/src/file/xml-components/xml-component.ts#L34">file/xml-components/xml-component.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -173,6 +181,78 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="addrunproperty" class="tsd-anchor"></a>
<h3>add<wbr>Run<wbr>Property</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">add<wbr>Run<wbr>Property<span class="tsd-signature-symbol">(</span>property<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="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#addrunproperty">addRunProperty</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/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>
<ul class="tsd-parameters">
<li>
<h5>property: <a href="xmlcomponent.html" class="tsd-signature-type">XmlComponent</a></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="basedon" class="tsd-anchor"></a>
<h3>based<wbr>On</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">based<wbr>On<span class="tsd-signature-symbol">(</span>parentId<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#basedon">basedOn</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/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>
<ul class="tsd-parameters">
<li>
<h5>parentId: <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="color" class="tsd-anchor"></a>
<h3>color</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">color<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#color">color</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/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>
<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="delete" class="tsd-anchor"></a>
<h3>delete</h3>
@ -184,13 +264,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/600f97d/src/file/xml-components/xml-component.ts#L40">file/xml-components/xml-component.ts:40</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/src/file/xml-components/xml-component.ts#L40">file/xml-components/xml-component.ts:40</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="link" class="tsd-anchor"></a>
<h3>link</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">link<span class="tsd-signature-symbol">(</span>link<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#link">link</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/src/file/styles/style/character-style.ts#L44">file/styles/style/character-style.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>link: <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-overwrite tsd-is-inherited tsd-is-external">
<a name="prepforxml" class="tsd-anchor"></a>
<h3>prep<wbr>For<wbr>Xml</h3>
@ -203,7 +307,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/600f97d/src/file/xml-components/xml-component.ts#L14">file/xml-components/xml-component.ts:14</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/src/file/xml-components/xml-component.ts#L14">file/xml-components/xml-component.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ixmlableobject.html" class="tsd-signature-type">IXmlableObject</a>
@ -224,7 +328,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/600f97d/src/file/styles/style/index.ts#L45">file/styles/style/index.ts:45</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/src/file/styles/style/style.ts#L29">file/styles/style/style.ts:29</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -237,6 +341,93 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="semihidden" class="tsd-anchor"></a>
<h3>semi<wbr>Hidden</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">semi<wbr>Hidden<span class="tsd-signature-symbol">(</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#semihidden">semiHidden</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/src/file/styles/style/character-style.ts#L49">file/styles/style/character-style.ts:49</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="size" class="tsd-anchor"></a>
<h3>size</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">size<span class="tsd-signature-symbol">(</span>twips<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="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#size">size</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/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>
<ul class="tsd-parameters">
<li>
<h5>twips: <span class="tsd-signature-type">number</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="superscript" class="tsd-anchor"></a>
<h3>super<wbr>Script</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">super<wbr>Script<span class="tsd-signature-symbol">(</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#superscript">superScript</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/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>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="underline" class="tsd-anchor"></a>
<h3>underline</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">underline<span class="tsd-signature-symbol">(</span>underlineType<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>, color<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="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#underline">underline</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bf18154/src/file/styles/style/character-style.ts#L32">file/styles/style/character-style.ts:32</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> underlineType: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> color: <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="characterstyle.html" class="tsd-signature-type">CharacterStyle</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@ -263,15 +454,39 @@
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="footnotereferencestyle.html#addchildelement" class="tsd-kind-icon">add<wbr>Child<wbr>Element</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="footnotereferencestyle.html#addrunproperty" class="tsd-kind-icon">add<wbr>Run<wbr>Property</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="footnotereferencestyle.html#basedon" class="tsd-kind-icon">based<wbr>On</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.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="footnotereferencestyle.html#underline" class="tsd-kind-icon">underline</a>
</li>
</ul>
</li>
</ul>