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-24 17:52:30 +00:00
parent 0f50563c8e
commit f5961d50fb
595 changed files with 3458 additions and 3081 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
api/globals.html
View File

@ -81,6 +81,7 @@
<li class="tsd-kind-enum tsd-is-external"><a href="enums/horizontalpositionrelativefrom.html" class="tsd-kind-icon">Horizontal<wbr>Position<wbr>Relative<wbr>From</a></li>
<li class="tsd-kind-enum tsd-is-external"><a href="enums/hyperlinktype.html" class="tsd-kind-icon">Hyperlink<wbr>Type</a></li>
<li class="tsd-kind-enum tsd-is-external"><a href="enums/leadertype.html" class="tsd-kind-icon">Leader<wbr>Type</a></li>
<li class="tsd-kind-enum tsd-is-external"><a href="enums/levelformat.html" class="tsd-kind-icon">Level<wbr>Format</a></li>
<li class="tsd-kind-enum tsd-is-external"><a href="enums/levelsuffix.html" class="tsd-kind-icon">Level<wbr>Suffix</a></li>
<li class="tsd-kind-enum tsd-is-external"><a href="enums/linenumberrestartformat.html" class="tsd-kind-icon">Line<wbr>Number<wbr>Restart<wbr>Format</a></li>
<li class="tsd-kind-enum tsd-is-external"><a href="enums/overlaptype.html" class="tsd-kind-icon">Overlap<wbr>Type</a></li>
@ -712,7 +713,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/86f8259/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/3ef26c7/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>
@ -733,7 +734,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/86f8259/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/3ef26c7/src/file/paragraph/math/math-component.ts#L9">src/file/paragraph/math/math-component.ts:9</a></li>
</ul>
</aside>
</section>
@ -743,7 +744,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/86f8259/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/3ef26c7/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>
@ -756,7 +757,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/86f8259/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/3ef26c7/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">
@ -778,7 +779,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/86f8259/src/convenience-functions.ts#L6">src/convenience-functions.ts:6</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/convenience-functions.ts#L6">src/convenience-functions.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -801,7 +802,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/86f8259/src/convenience-functions.ts#L2">src/convenience-functions.ts:2</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ef26c7/src/convenience-functions.ts#L2">src/convenience-functions.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -824,7 +825,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/86f8259/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/3ef26c7/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">
@ -854,7 +855,7 @@
<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/86f8259/src/file/drawing/anchor/anchor.ts#L14">src/file/drawing/anchor/anchor.ts:14</a></li>
<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">
@ -863,7 +864,7 @@
<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/86f8259/src/file/drawing/anchor/anchor.ts#L15">src/file/drawing/anchor/anchor.ts:15</a></li>
<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>
@ -873,7 +874,7 @@
<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/86f8259/src/file/drawing/anchor/anchor.ts#L16">src/file/drawing/anchor/anchor.ts:16</a></li>
<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>
@ -883,7 +884,7 @@
<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/86f8259/src/file/drawing/anchor/anchor.ts#L20">src/file/drawing/anchor/anchor.ts:20</a></li>
<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">
@ -898,7 +899,7 @@
<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/86f8259/src/file/drawing/anchor/anchor.ts#L18">src/file/drawing/anchor/anchor.ts:18</a></li>
<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>
@ -908,7 +909,7 @@
<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/86f8259/src/file/drawing/anchor/anchor.ts#L17">src/file/drawing/anchor/anchor.ts:17</a></li>
<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>
@ -918,7 +919,7 @@
<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/86f8259/src/file/drawing/anchor/anchor.ts#L19">src/file/drawing/anchor/anchor.ts:19</a></li>
<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">
@ -934,7 +935,7 @@
<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/86f8259/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/3ef26c7/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">
@ -943,7 +944,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/86f8259/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/3ef26c7/src/import-dotx/import-dotx.ts#L14">src/import-dotx/import-dotx.ts:14</a></li>
</ul>
</aside>
</section>
@ -953,7 +954,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/86f8259/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/3ef26c7/src/import-dotx/import-dotx.ts#L13">src/import-dotx/import-dotx.ts:13</a></li>
</ul>
</aside>
</section>
@ -963,7 +964,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/86f8259/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/3ef26c7/src/import-dotx/import-dotx.ts#L16">src/import-dotx/import-dotx.ts:16</a></li>
</ul>
</aside>
</section>
@ -973,7 +974,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/86f8259/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/3ef26c7/src/import-dotx/import-dotx.ts#L15">src/import-dotx/import-dotx.ts:15</a></li>
</ul>
</aside>
</section>
@ -1029,6 +1030,9 @@
<li class=" tsd-kind-enum tsd-is-external">
<a href="enums/leadertype.html" class="tsd-kind-icon">Leader<wbr>Type</a>
</li>
<li class=" tsd-kind-enum tsd-is-external">
<a href="enums/levelformat.html" class="tsd-kind-icon">Level<wbr>Format</a>
</li>
<li class=" tsd-kind-enum tsd-is-external">
<a href="enums/levelsuffix.html" class="tsd-kind-icon">Level<wbr>Suffix</a>
</li>