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)
2021-02-23 00:08:18 +00:00
parent 41073bdfc9
commit ba2447879b
598 changed files with 4030 additions and 3085 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
api/globals.html
View File

@ -94,6 +94,7 @@
<li class="tsd-kind-enum tsd-is-external"><a href="enums/relationshiptype.html" class="tsd-kind-icon">Relationship<wbr>Type</a></li>
<li class="tsd-kind-enum tsd-is-external"><a href="enums/relativehorizontalposition.html" class="tsd-kind-icon">Relative<wbr>Horizontal<wbr>Position</a></li>
<li class="tsd-kind-enum tsd-is-external"><a href="enums/relativeverticalposition.html" class="tsd-kind-icon">Relative<wbr>Vertical<wbr>Position</a></li>
<li class="tsd-kind-enum tsd-is-external"><a href="enums/sectiontype.html" class="tsd-kind-icon">Section<wbr>Type</a></li>
<li class="tsd-kind-enum tsd-is-external"><a href="enums/sectionverticalalignvalue.html" class="tsd-kind-icon">Section<wbr>Vertical<wbr>Align<wbr>Value</a></li>
<li class="tsd-kind-enum tsd-is-external"><a href="enums/shadingtype.html" class="tsd-kind-icon">Shading<wbr>Type</a></li>
<li class="tsd-kind-enum tsd-is-external"><a href="enums/spacetype.html" class="tsd-kind-icon">Space<wbr>Type</a></li>
@ -414,6 +415,7 @@
<li class="tsd-kind-class tsd-is-external"><a href="classes/runproperties.html" class="tsd-kind-icon">Run<wbr>Properties</a></li>
<li class="tsd-kind-class tsd-is-external"><a href="classes/runpropertiesdefaults.html" class="tsd-kind-icon">Run<wbr>Properties<wbr>Defaults</a></li>
<li class="tsd-kind-class tsd-is-external"><a href="classes/sectionproperties.html" class="tsd-kind-icon">Section<wbr>Properties</a></li>
<li class="tsd-kind-class tsd-is-external"><a href="classes/sectiontypeattributes.html" class="tsd-kind-icon">Section<wbr>Type<wbr>Attributes</a></li>
<li class="tsd-kind-class tsd-is-external"><a href="classes/sectionverticalalign.html" class="tsd-kind-icon">Section<wbr>Vertical<wbr>Align</a></li>
<li class="tsd-kind-class tsd-is-external"><a href="classes/sectionverticalalignattributes.html" class="tsd-kind-icon">Section<wbr>Vertical<wbr>Align<wbr>Attributes</a></li>
<li class="tsd-kind-class tsd-is-external"><a href="classes/semihidden.html" class="tsd-kind-icon">Semi<wbr>Hidden</a></li>
@ -504,6 +506,7 @@
<li class="tsd-kind-class tsd-is-external"><a href="classes/titlestyle.html" class="tsd-kind-icon">Title<wbr>Style</a></li>
<li class="tsd-kind-class tsd-is-external"><a href="classes/topcellmargin.html" class="tsd-kind-icon">Top<wbr>Cell<wbr>Margin</a></li>
<li class="tsd-kind-class tsd-is-external"><a href="classes/trackrevisions.html" class="tsd-kind-icon">Track<wbr>Revisions</a></li>
<li class="tsd-kind-class tsd-is-external"><a href="classes/type.html" class="tsd-kind-icon">Type</a></li>
<li class="tsd-kind-class tsd-is-external"><a href="classes/uipriority.html" class="tsd-kind-icon">Ui<wbr>Priority</a></li>
<li class="tsd-kind-class tsd-is-external"><a href="classes/underline.html" class="tsd-kind-icon">Underline</a></li>
<li class="tsd-kind-class tsd-is-external"><a href="classes/unhidewhenused.html" class="tsd-kind-icon">Unhide<wbr>When<wbr>Used</a></li>
@ -712,7 +715,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/bb2f77a/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/5e06d73/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,17 +736,17 @@
<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/bb2f77a/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/5e06d73/src/file/paragraph/math/math-component.ts#L9">src/file/paragraph/math/math-component.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
<a name="sectionpropertiesoptions" class="tsd-anchor"></a>
<h3>Section<wbr>Properties<wbr>Options</h3>
<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>
<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>type<span class="tsd-signature-symbol">?: </span><a href="enums/sectiontype.html" class="tsd-signature-type">SectionType</a><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bb2f77a/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/5e06d73/src/file/document/body/section-properties/section-properties.ts#L44">src/file/document/body/section-properties/section-properties.ts:44</a></li>
</ul>
</aside>
</section>
@ -756,7 +759,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/bb2f77a/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/5e06d73/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 +781,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bb2f77a/src/convenience-functions.ts#L6">src/convenience-functions.ts:6</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/5e06d73/src/convenience-functions.ts#L6">src/convenience-functions.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -801,7 +804,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bb2f77a/src/convenience-functions.ts#L2">src/convenience-functions.ts:2</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/5e06d73/src/convenience-functions.ts#L2">src/convenience-functions.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -824,7 +827,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/bb2f77a/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/5e06d73/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 +857,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/bb2f77a/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/5e06d73/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">
@ -863,7 +866,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/bb2f77a/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/5e06d73/src/import-dotx/import-dotx.ts#L14">src/import-dotx/import-dotx.ts:14</a></li>
</ul>
</aside>
</section>
@ -873,7 +876,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/bb2f77a/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/5e06d73/src/import-dotx/import-dotx.ts#L13">src/import-dotx/import-dotx.ts:13</a></li>
</ul>
</aside>
</section>
@ -883,7 +886,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/bb2f77a/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/5e06d73/src/import-dotx/import-dotx.ts#L16">src/import-dotx/import-dotx.ts:16</a></li>
</ul>
</aside>
</section>
@ -893,7 +896,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/bb2f77a/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/5e06d73/src/import-dotx/import-dotx.ts#L15">src/import-dotx/import-dotx.ts:15</a></li>
</ul>
</aside>
</section>
@ -988,6 +991,9 @@
<li class=" tsd-kind-enum tsd-is-external">
<a href="enums/relativeverticalposition.html" class="tsd-kind-icon">Relative<wbr>Vertical<wbr>Position</a>
</li>
<li class=" tsd-kind-enum tsd-is-external">
<a href="enums/sectiontype.html" class="tsd-kind-icon">Section<wbr>Type</a>
</li>
<li class=" tsd-kind-enum tsd-is-external">
<a href="enums/sectionverticalalignvalue.html" class="tsd-kind-icon">Section<wbr>Vertical<wbr>Align<wbr>Value</a>
</li>
@ -1933,6 +1939,9 @@
<li class=" tsd-kind-class tsd-is-external">
<a href="classes/sectionproperties.html" class="tsd-kind-icon">Section<wbr>Properties</a>
</li>
<li class=" tsd-kind-class tsd-is-external">
<a href="classes/sectiontypeattributes.html" class="tsd-kind-icon">Section<wbr>Type<wbr>Attributes</a>
</li>
<li class=" tsd-kind-class tsd-is-external">
<a href="classes/sectionverticalalign.html" class="tsd-kind-icon">Section<wbr>Vertical<wbr>Align</a>
</li>
@ -2203,6 +2212,9 @@
<li class=" tsd-kind-class tsd-is-external">
<a href="classes/trackrevisions.html" class="tsd-kind-icon">Track<wbr>Revisions</a>
</li>
<li class=" tsd-kind-class tsd-is-external">
<a href="classes/type.html" class="tsd-kind-icon">Type</a>
</li>
<li class=" tsd-kind-class tsd-is-external">
<a href="classes/uipriority.html" class="tsd-kind-icon">Ui<wbr>Priority</a>
</li>