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 03:48:35 +00:00
parent 3025a018c5
commit 0f50563c8e
595 changed files with 3156 additions and 3071 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
api/globals.html
View File

@ -689,6 +689,8 @@
<section class="tsd-index-section tsd-is-external">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-is-external"><a href="globals.html#convertinchestotwip" class="tsd-kind-icon">convert<wbr>Inches<wbr>ToTwip</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="globals.html#convertmillimeterstotwip" class="tsd-kind-icon">convert<wbr>Millimeters<wbr>ToTwip</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="globals.html#converttoxmlcomponent" class="tsd-kind-icon">convert<wbr>ToXml<wbr>Component</a></li>
</ul>
</section>
@ -710,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/ef12ada/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/86f8259/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>
@ -731,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/ef12ada/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/86f8259/src/file/paragraph/math/math-component.ts#L9">src/file/paragraph/math/math-component.ts:9</a></li>
</ul>
</aside>
</section>
@ -741,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/ef12ada/src/file/document/body/section-properties/section-properties.ts#L41">src/file/document/body/section-properties/section-properties.ts:41</a></li>
<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>
</ul>
</aside>
</section>
@ -754,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/ef12ada/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/86f8259/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">
@ -766,6 +768,52 @@
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="convertinchestotwip" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> convert<wbr>Inches<wbr>ToTwip</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">convert<wbr>Inches<wbr>ToTwip<span class="tsd-signature-symbol">(</span>inches<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><span class="tsd-signature-type">number</span></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/86f8259/src/convenience-functions.ts#L6">src/convenience-functions.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>inches: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="convertmillimeterstotwip" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> convert<wbr>Millimeters<wbr>ToTwip</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">convert<wbr>Millimeters<wbr>ToTwip<span class="tsd-signature-symbol">(</span>millimeters<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><span class="tsd-signature-type">number</span></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/86f8259/src/convenience-functions.ts#L2">src/convenience-functions.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>millimeters: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="converttoxmlcomponent" class="tsd-anchor"></a>
<h3>convert<wbr>ToXml<wbr>Component</h3>
@ -776,7 +824,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/ef12ada/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/86f8259/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">
@ -806,7 +854,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/ef12ada/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/86f8259/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">
@ -815,7 +863,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/ef12ada/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/86f8259/src/file/drawing/anchor/anchor.ts#L15">src/file/drawing/anchor/anchor.ts:15</a></li>
</ul>
</aside>
</section>
@ -825,7 +873,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/ef12ada/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/86f8259/src/file/drawing/anchor/anchor.ts#L16">src/file/drawing/anchor/anchor.ts:16</a></li>
</ul>
</aside>
</section>
@ -835,7 +883,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/ef12ada/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/86f8259/src/file/drawing/anchor/anchor.ts#L20">src/file/drawing/anchor/anchor.ts:20</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@ -850,7 +898,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/ef12ada/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/86f8259/src/file/drawing/anchor/anchor.ts#L18">src/file/drawing/anchor/anchor.ts:18</a></li>
</ul>
</aside>
</section>
@ -860,7 +908,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/ef12ada/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/86f8259/src/file/drawing/anchor/anchor.ts#L17">src/file/drawing/anchor/anchor.ts:17</a></li>
</ul>
</aside>
</section>
@ -870,7 +918,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/ef12ada/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/86f8259/src/file/drawing/anchor/anchor.ts#L19">src/file/drawing/anchor/anchor.ts:19</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@ -886,7 +934,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/ef12ada/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/86f8259/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">
@ -895,7 +943,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/ef12ada/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/86f8259/src/import-dotx/import-dotx.ts#L14">src/import-dotx/import-dotx.ts:14</a></li>
</ul>
</aside>
</section>
@ -905,7 +953,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/ef12ada/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/86f8259/src/import-dotx/import-dotx.ts#L13">src/import-dotx/import-dotx.ts:13</a></li>
</ul>
</aside>
</section>
@ -915,7 +963,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/ef12ada/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/86f8259/src/import-dotx/import-dotx.ts#L16">src/import-dotx/import-dotx.ts:16</a></li>
</ul>
</aside>
</section>
@ -925,7 +973,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/ef12ada/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/86f8259/src/import-dotx/import-dotx.ts#L15">src/import-dotx/import-dotx.ts:15</a></li>
</ul>
</aside>
</section>
@ -2730,6 +2778,12 @@
<li class=" tsd-kind-variable tsd-is-external">
<a href="globals.html#empty_object" class="tsd-kind-icon">EMPTY_<wbr>OBJECT</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="globals.html#convertinchestotwip" class="tsd-kind-icon">convert<wbr>Inches<wbr>ToTwip</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="globals.html#convertmillimeterstotwip" class="tsd-kind-icon">convert<wbr>Millimeters<wbr>ToTwip</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="globals.html#converttoxmlcomponent" class="tsd-kind-icon">convert<wbr>ToXml<wbr>Component</a>
</li>