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)
2020-12-25 02:29:33 +00:00
parent f5961d50fb
commit 0596d0d7dc
596 changed files with 3096 additions and 3168 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
api/globals.html
View File

@ -698,7 +698,6 @@
<section class="tsd-index-section tsd-is-external">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal tsd-is-external"><a href="globals.html#defaultoptions" class="tsd-kind-icon">default<wbr>Options</a></li>
<li class="tsd-kind-object-literal tsd-is-external"><a href="globals.html#schemetotype" class="tsd-kind-icon">scheme<wbr>ToType</a></li>
</ul>
</section>
@ -713,7 +712,7 @@
<div class="tsd-signature tsd-kind-icon">Attribute<wbr>Map&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/file/xml-components/default-attributes.ts#L4">src/file/xml-components/default-attributes.ts:4</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d41ef99/src/file/xml-components/default-attributes.ts#L4">src/file/xml-components/default-attributes.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -734,7 +733,7 @@
<div class="tsd-signature tsd-kind-icon">Math<wbr>Component<span class="tsd-signature-symbol">:</span> <a href="classes/mathrun.html" class="tsd-signature-type">MathRun</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathfraction.html" class="tsd-signature-type">MathFraction</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathsum.html" class="tsd-signature-type">MathSum</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathsuperscript.html" class="tsd-signature-type">MathSuperScript</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathsubscript.html" class="tsd-signature-type">MathSubScript</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathsubsuperscript.html" class="tsd-signature-type">MathSubSuperScript</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathradical.html" class="tsd-signature-type">MathRadical</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathfunction.html" class="tsd-signature-type">MathFunction</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathroundbrackets.html" class="tsd-signature-type">MathRoundBrackets</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathcurlybrackets.html" class="tsd-signature-type">MathCurlyBrackets</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathangledbrackets.html" class="tsd-signature-type">MathAngledBrackets</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathsquarebrackets.html" class="tsd-signature-type">MathSquareBrackets</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/file/paragraph/math/math-component.ts#L9">src/file/paragraph/math/math-component.ts:9</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d41ef99/src/file/paragraph/math/math-component.ts#L9">src/file/paragraph/math/math-component.ts:9</a></li>
</ul>
</aside>
</section>
@ -744,7 +743,7 @@
<div class="tsd-signature tsd-kind-icon">Section<wbr>Properties<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="interfaces/ipagesizeattributes.html" class="tsd-signature-type">IPageSizeAttributes</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ipagemarginattributes.html" class="tsd-signature-type">IPageMarginAttributes</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/idocgridattributesproperties.html" class="tsd-signature-type">IDocGridAttributesProperties</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/iheadersoptions.html" class="tsd-signature-type">IHeadersOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ifootersoptions.html" class="tsd-signature-type">IFootersOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ipagenumbertypeattributes.html" class="tsd-signature-type">IPageNumberTypeAttributes</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ilinenumberattributes.html" class="tsd-signature-type">ILineNumberAttributes</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ipagebordersoptions.html" class="tsd-signature-type">IPageBordersOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ititlepageoptions.html" class="tsd-signature-type">ITitlePageOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/isectionverticalalignattributes.html" class="tsd-signature-type">ISectionVerticalAlignAttributes</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>column<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>count<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>space<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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/file/document/body/section-properties/section-properties.ts#L42">src/file/document/body/section-properties/section-properties.ts:42</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d41ef99/src/file/document/body/section-properties/section-properties.ts#L42">src/file/document/body/section-properties/section-properties.ts:42</a></li>
</ul>
</aside>
</section>
@ -757,7 +756,7 @@
<div class="tsd-signature tsd-kind-icon">EMPTY_<wbr>OBJECT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = Object.seal({})</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/file/xml-components/xml-component.ts#L5">src/file/xml-components/xml-component.ts:5</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d41ef99/src/file/xml-components/xml-component.ts#L5">src/file/xml-components/xml-component.ts:5</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@ -779,7 +778,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/convenience-functions.ts#L6">src/convenience-functions.ts:6</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d41ef99/src/convenience-functions.ts#L6">src/convenience-functions.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -802,7 +801,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/convenience-functions.ts#L2">src/convenience-functions.ts:2</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d41ef99/src/convenience-functions.ts#L2">src/convenience-functions.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -825,7 +824,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/file/xml-components/imported-xml-component.ts#L10">src/file/xml-components/imported-xml-component.ts:10</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d41ef99/src/file/xml-components/imported-xml-component.ts#L10">src/file/xml-components/imported-xml-component.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -849,93 +848,13 @@
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-is-external">
<a name="defaultoptions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> default<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/file/drawing/anchor/anchor.ts#L14">src/file/drawing/anchor/anchor.ts:14</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external">
<a name="defaultoptions.allowoverlap" class="tsd-anchor"></a>
<h3>allow<wbr>Overlap</h3>
<div class="tsd-signature tsd-kind-icon">allow<wbr>Overlap<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/file/drawing/anchor/anchor.ts#L15">src/file/drawing/anchor/anchor.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external">
<a name="defaultoptions.behinddocument" class="tsd-anchor"></a>
<h3>behind<wbr>Document</h3>
<div class="tsd-signature tsd-kind-icon">behind<wbr>Document<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/file/drawing/anchor/anchor.ts#L16">src/file/drawing/anchor/anchor.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external">
<a name="defaultoptions.horizontalposition" class="tsd-anchor"></a>
<h3>horizontal<wbr>Position</h3>
<div class="tsd-signature tsd-kind-icon">horizontal<wbr>Position<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/file/drawing/anchor/anchor.ts#L20">src/file/drawing/anchor/anchor.ts:20</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external">
<a name="defaultoptions.layoutincell" class="tsd-anchor"></a>
<h3>layout<wbr>InCell</h3>
<div class="tsd-signature tsd-kind-icon">layout<wbr>InCell<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/file/drawing/anchor/anchor.ts#L18">src/file/drawing/anchor/anchor.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external">
<a name="defaultoptions.lockanchor" class="tsd-anchor"></a>
<h3>lock<wbr>Anchor</h3>
<div class="tsd-signature tsd-kind-icon">lock<wbr>Anchor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/file/drawing/anchor/anchor.ts#L17">src/file/drawing/anchor/anchor.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external">
<a name="defaultoptions.verticalposition" class="tsd-anchor"></a>
<h3>vertical<wbr>Position</h3>
<div class="tsd-signature tsd-kind-icon">vertical<wbr>Position<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/file/drawing/anchor/anchor.ts#L19">src/file/drawing/anchor/anchor.ts:19</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
</ul>
</div>
</section>
</section>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-is-external">
<a name="schemetotype" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> scheme<wbr>ToType</h3>
<div class="tsd-signature tsd-kind-icon">scheme<wbr>ToType<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/import-dotx/import-dotx.ts#L12">src/import-dotx/import-dotx.ts:12</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d41ef99/src/import-dotx/import-dotx.ts#L12">src/import-dotx/import-dotx.ts:12</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external">
@ -944,7 +863,7 @@
<div class="tsd-signature tsd-kind-icon">http://schemas.openxmlformats.org/office<wbr>Document/2006/relationships/footer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;footer&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/import-dotx/import-dotx.ts#L14">src/import-dotx/import-dotx.ts:14</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d41ef99/src/import-dotx/import-dotx.ts#L14">src/import-dotx/import-dotx.ts:14</a></li>
</ul>
</aside>
</section>
@ -954,7 +873,7 @@
<div class="tsd-signature tsd-kind-icon">http://schemas.openxmlformats.org/office<wbr>Document/2006/relationships/header<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;header&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/import-dotx/import-dotx.ts#L13">src/import-dotx/import-dotx.ts:13</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d41ef99/src/import-dotx/import-dotx.ts#L13">src/import-dotx/import-dotx.ts:13</a></li>
</ul>
</aside>
</section>
@ -964,7 +883,7 @@
<div class="tsd-signature tsd-kind-icon">http://schemas.openxmlformats.org/office<wbr>Document/2006/relationships/hyperlink<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;hyperlink&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/import-dotx/import-dotx.ts#L16">src/import-dotx/import-dotx.ts:16</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d41ef99/src/import-dotx/import-dotx.ts#L16">src/import-dotx/import-dotx.ts:16</a></li>
</ul>
</aside>
</section>
@ -974,7 +893,7 @@
<div class="tsd-signature tsd-kind-icon">http://schemas.openxmlformats.org/office<wbr>Document/2006/relationships/image<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;image&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/import-dotx/import-dotx.ts#L15">src/import-dotx/import-dotx.ts:15</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d41ef99/src/import-dotx/import-dotx.ts#L15">src/import-dotx/import-dotx.ts:15</a></li>
</ul>
</aside>
</section>
@ -2791,9 +2710,6 @@
<li class=" tsd-kind-function tsd-is-external">
<a href="globals.html#converttoxmlcomponent" class="tsd-kind-icon">convert<wbr>ToXml<wbr>Component</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-external">
<a href="globals.html#defaultoptions" class="tsd-kind-icon">default<wbr>Options</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-external">
<a href="globals.html#schemetotype" class="tsd-kind-icon">scheme<wbr>ToType</a>
</li>