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-10-10 20:31:32 +00:00
parent 080c8acb0f
commit 11a2e5b14f
419 changed files with 4492 additions and 15842 deletions
Download Patch File Download Diff File Expand all files Collapse all files

126
api/classes/styles.html
View File

@ -93,16 +93,12 @@
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="styles.html#isdeleted" class="tsd-kind-icon">Is<wbr>Deleted</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<section class="tsd-index-section tsd-is-inherited tsd-is-external">
<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="styles.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="styles.html#createcharacterstyle" class="tsd-kind-icon">create<wbr>Character<wbr>Style</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="styles.html#createdocumentdefaults" class="tsd-kind-icon">create<wbr>Document<wbr>Defaults</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="styles.html#createparagraphstyle" class="tsd-kind-icon">create<wbr>Paragraph<wbr>Style</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="styles.html#delete" class="tsd-kind-icon">delete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="styles.html#prepforxml" class="tsd-kind-icon">prep<wbr>For<wbr>Xml</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="styles.html#push" class="tsd-kind-icon">push</a></li>
</ul>
</section>
</div>
@ -114,20 +110,20 @@
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<li class="tsd-signature tsd-kind-icon">new <wbr>Styles<span class="tsd-signature-symbol">(</span>initialStyles<span class="tsd-signature-symbol">?: </span><a href="basexmlcomponent.html" class="tsd-signature-type">BaseXmlComponent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="styles.html" class="tsd-signature-type">Styles</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Styles<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/istylesoptions.html" class="tsd-signature-type">IStylesOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="styles.html" class="tsd-signature-type">Styles</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="xmlcomponent.html">XmlComponent</a>.<a href="xmlcomponent.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/5d401df/src/file/styles/styles.ts#L6">file/styles/styles.ts:6</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/fefefdd/src/file/styles/styles.ts#L15">file/styles/styles.ts:15</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> initialStyles: <a href="basexmlcomponent.html" class="tsd-signature-type">BaseXmlComponent</a></h5>
<h5>options: <a href="../interfaces/istylesoptions.html" class="tsd-signature-type">IStylesOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="styles.html" class="tsd-signature-type">Styles</a></h4>
@ -148,7 +144,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/5d401df/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/fefefdd/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>
@ -156,7 +152,7 @@
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="addchildelement" class="tsd-anchor"></a>
@ -169,7 +165,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/5d401df/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/fefefdd/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>
@ -182,75 +178,6 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="createcharacterstyle" class="tsd-anchor"></a>
<h3>create<wbr>Character<wbr>Style</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">create<wbr>Character<wbr>Style<span class="tsd-signature-symbol">(</span>styleId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, name<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">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/5d401df/src/file/styles/styles.ts#L31">file/styles/styles.ts:31</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>styleId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> name: <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 class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="createdocumentdefaults" class="tsd-anchor"></a>
<h3>create<wbr>Document<wbr>Defaults</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">create<wbr>Document<wbr>Defaults<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="documentdefaults.html" class="tsd-signature-type">DocumentDefaults</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/5d401df/src/file/styles/styles.ts#L19">file/styles/styles.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="documentdefaults.html" class="tsd-signature-type">DocumentDefaults</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="createparagraphstyle" class="tsd-anchor"></a>
<h3>create<wbr>Paragraph<wbr>Style</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<wbr>Style<span class="tsd-signature-symbol">(</span>styleId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, name<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="paragraphstyle.html" class="tsd-signature-type">ParagraphStyle</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/5d401df/src/file/styles/styles.ts#L25">file/styles/styles.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>styleId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> name: <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="paragraphstyle.html" class="tsd-signature-type">ParagraphStyle</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>
@ -262,7 +189,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/5d401df/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/fefefdd/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>
@ -281,7 +208,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/5d401df/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/fefefdd/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>
@ -291,29 +218,6 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="push" class="tsd-anchor"></a>
<h3>push</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">push<span class="tsd-signature-symbol">(</span>style<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="styles.html" class="tsd-signature-type">Styles</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/5d401df/src/file/styles/styles.ts#L14">file/styles/styles.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>style: <a href="xmlcomponent.html" class="tsd-signature-type">XmlComponent</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="styles.html" class="tsd-signature-type">Styles</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@ -340,24 +244,12 @@
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="styles.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="styles.html#createcharacterstyle" class="tsd-kind-icon">create<wbr>Character<wbr>Style</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="styles.html#createdocumentdefaults" class="tsd-kind-icon">create<wbr>Document<wbr>Defaults</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="styles.html#createparagraphstyle" class="tsd-kind-icon">create<wbr>Paragraph<wbr>Style</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="styles.html#delete" class="tsd-kind-icon">delete</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external">
<a href="styles.html#prepforxml" class="tsd-kind-icon">prep<wbr>For<wbr>Xml</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="styles.html#push" class="tsd-kind-icon">push</a>
</li>
</ul>
</li>
</ul>