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-03-15 00:17:55 +00:00
parent 6839842d3c
commit d0bfd806f7
291 changed files with 1802 additions and 2426 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
api/modules.html
View File

@ -290,7 +290,6 @@
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/iattributesproperties.html" class="tsd-kind-icon">IAttributes<wbr>Properties</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ibasecharacterstyleoptions.html" class="tsd-kind-icon">IBase<wbr>Character<wbr>Style<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ibaseparagraphstyleoptions.html" class="tsd-kind-icon">IBase<wbr>Paragraph<wbr>Style<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/iborderoptions.html" class="tsd-kind-icon">IBorder<wbr>Options</a></li>
@ -310,11 +309,9 @@
<li class="tsd-kind-interface"><a href="interfaces/ifloating.html" class="tsd-kind-icon">IFloating</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ifontattributesproperties.html" class="tsd-kind-icon">IFont<wbr>Attributes<wbr>Properties</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ifooteroptions.html" class="tsd-kind-icon">IFooter<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ifooterreferenceattributes.html" class="tsd-kind-icon">IFooter<wbr>Reference<wbr>Attributes</a></li>
<li class="tsd-kind-interface"><a href="interfaces/iframeoptions.html" class="tsd-kind-icon">IFrame<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/iheaderfootergroup.html" class="tsd-kind-icon">IHeader<wbr>Footer<wbr>Group</a></li>
<li class="tsd-kind-interface"><a href="interfaces/iheaderoptions.html" class="tsd-kind-icon">IHeader<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/iheaderreferenceattributes.html" class="tsd-kind-icon">IHeader<wbr>Reference<wbr>Attributes</a></li>
<li class="tsd-kind-interface"><a href="interfaces/iheaderreferenceoptions.html" class="tsd-kind-icon">IHeader<wbr>Reference<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ihorizontalpositionoptions.html" class="tsd-kind-icon">IHorizontal<wbr>Position<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/iindentattributesproperties.html" class="tsd-kind-icon">IIndent<wbr>Attributes<wbr>Properties</a></li>
@ -400,7 +397,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><span class="tsd-signature-symbol">[ </span><span class="tsd-signature-type">P</span><span class="tsd-signature-symbol"> in </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/18ce200/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/a3febae/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>
@ -416,7 +413,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" data-tsd-kind="Class">MathRun</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathfraction.html" class="tsd-signature-type" data-tsd-kind="Class">MathFraction</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathsum.html" class="tsd-signature-type" data-tsd-kind="Class">MathSum</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathsuperscript.html" class="tsd-signature-type" data-tsd-kind="Class">MathSuperScript</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathsubscript.html" class="tsd-signature-type" data-tsd-kind="Class">MathSubScript</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathsubsuperscript.html" class="tsd-signature-type" data-tsd-kind="Class">MathSubSuperScript</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathradical.html" class="tsd-signature-type" data-tsd-kind="Class">MathRadical</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathfunction.html" class="tsd-signature-type" data-tsd-kind="Class">MathFunction</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathroundbrackets.html" class="tsd-signature-type" data-tsd-kind="Class">MathRoundBrackets</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathcurlybrackets.html" class="tsd-signature-type" data-tsd-kind="Class">MathCurlyBrackets</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathangledbrackets.html" class="tsd-signature-type" data-tsd-kind="Class">MathAngledBrackets</a><span class="tsd-signature-symbol"> | </span><a href="classes/mathsquarebrackets.html" class="tsd-signature-type" data-tsd-kind="Class">MathSquareBrackets</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/18ce200/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/a3febae/src/file/paragraph/math/math-component.ts#L9">src/file/paragraph/math/math-component.ts:9</a></li>
</ul>
</aside>
</section>
@ -426,7 +423,7 @@
<div class="tsd-signature tsd-kind-icon">Paragraph<wbr>Child<span class="tsd-signature-symbol">:</span> <a href="classes/textrun.html" class="tsd-signature-type" data-tsd-kind="Class">TextRun</a><span class="tsd-signature-symbol"> | </span><a href="classes/picturerun.html" class="tsd-signature-type" data-tsd-kind="Class">PictureRun</a><span class="tsd-signature-symbol"> | </span><a href="classes/symbolrun.html" class="tsd-signature-type" data-tsd-kind="Class">SymbolRun</a><span class="tsd-signature-symbol"> | </span><a href="classes/bookmark.html" class="tsd-signature-type" data-tsd-kind="Class">Bookmark</a><span class="tsd-signature-symbol"> | </span><a href="classes/pagebreak.html" class="tsd-signature-type" data-tsd-kind="Class">PageBreak</a><span class="tsd-signature-symbol"> | </span><a href="classes/sequentialidentifier.html" class="tsd-signature-type" data-tsd-kind="Class">SequentialIdentifier</a><span class="tsd-signature-symbol"> | </span><a href="classes/footnotereferencerun.html" class="tsd-signature-type" data-tsd-kind="Class">FootnoteReferenceRun</a><span class="tsd-signature-symbol"> | </span><a href="classes/internalhyperlink.html" class="tsd-signature-type" data-tsd-kind="Class">InternalHyperlink</a><span class="tsd-signature-symbol"> | </span><a href="classes/externalhyperlink.html" class="tsd-signature-type" data-tsd-kind="Class">ExternalHyperlink</a><span class="tsd-signature-symbol"> | </span><a href="classes/insertedtextrun.html" class="tsd-signature-type" data-tsd-kind="Class">InsertedTextRun</a><span class="tsd-signature-symbol"> | </span><a href="classes/deletedtextrun.html" class="tsd-signature-type" data-tsd-kind="Class">DeletedTextRun</a><span class="tsd-signature-symbol"> | </span><a href="classes/math.html" class="tsd-signature-type" data-tsd-kind="Class">Math</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/18ce200/src/file/paragraph/paragraph.ts#L15">src/file/paragraph/paragraph.ts:15</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a3febae/src/file/paragraph/paragraph.ts#L15">src/file/paragraph/paragraph.ts:15</a></li>
</ul>
</aside>
</section>
@ -436,7 +433,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" data-tsd-kind="Interface">IPageSizeAttributes</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">IPageMarginAttributes</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">IDocGridAttributesProperties</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">IHeadersOptions</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">IFootersOptions</span><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ipagenumbertypeattributes.html" class="tsd-signature-type" data-tsd-kind="Interface">IPageNumberTypeAttributes</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ilinenumberattributes.html" class="tsd-signature-type" data-tsd-kind="Interface">ILineNumberAttributes</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ipagebordersoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IPageBordersOptions</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">ITitlePageOptions</span><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/isectionverticalalignattributes.html" class="tsd-signature-type" data-tsd-kind="Interface">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-symbol">{ </span>count<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>separate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>space<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" data-tsd-kind="Enumeration">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/18ce200/src/file/document/body/section-properties/section-properties.ts#L44">src/file/document/body/section-properties/section-properties.ts:44</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a3febae/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>
@ -449,7 +446,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"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/18ce200/src/file/xml-components/xml-component.ts#L4">src/file/xml-components/xml-component.ts:4</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a3febae/src/file/xml-components/xml-component.ts#L4">src/file/xml-components/xml-component.ts:4</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@ -471,7 +468,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/18ce200/src/convenience-functions.ts#L10">src/convenience-functions.ts:10</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a3febae/src/convenience-functions.ts#L10">src/convenience-functions.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -494,7 +491,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/18ce200/src/convenience-functions.ts#L6">src/convenience-functions.ts:6</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a3febae/src/convenience-functions.ts#L6">src/convenience-functions.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -517,7 +514,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/18ce200/src/file/xml-components/imported-xml-component.ts#L11">src/file/xml-components/imported-xml-component.ts:11</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a3febae/src/file/xml-components/imported-xml-component.ts#L11">src/file/xml-components/imported-xml-component.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -548,7 +545,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/18ce200/src/convenience-functions.ts#L18">src/convenience-functions.ts:18</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a3febae/src/convenience-functions.ts#L18">src/convenience-functions.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@ -565,7 +562,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/18ce200/src/convenience-functions.ts#L14">src/convenience-functions.ts:14</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a3febae/src/convenience-functions.ts#L14">src/convenience-functions.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
@ -1232,9 +1229,6 @@
<li class=" tsd-kind-class">
<a href="classes/xmlcomponent.html" class="tsd-kind-icon">Xml<wbr>Component</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/iattributesproperties.html" class="tsd-kind-icon">IAttributes<wbr>Properties</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ibasecharacterstyleoptions.html" class="tsd-kind-icon">IBase<wbr>Character<wbr>Style<wbr>Options</a>
</li>
@ -1292,9 +1286,6 @@
<li class=" tsd-kind-interface">
<a href="interfaces/ifooteroptions.html" class="tsd-kind-icon">IFooter<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ifooterreferenceattributes.html" class="tsd-kind-icon">IFooter<wbr>Reference<wbr>Attributes</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/iframeoptions.html" class="tsd-kind-icon">IFrame<wbr>Options</a>
</li>
@ -1304,9 +1295,6 @@
<li class=" tsd-kind-interface">
<a href="interfaces/iheaderoptions.html" class="tsd-kind-icon">IHeader<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/iheaderreferenceattributes.html" class="tsd-kind-icon">IHeader<wbr>Reference<wbr>Attributes</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/iheaderreferenceoptions.html" class="tsd-kind-icon">IHeader<wbr>Reference<wbr>Options</a>
</li>