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)
2019-12-27 01:47:32 +00:00
parent 4b4978e0e3
commit 2d0e0c162c
428 changed files with 5002 additions and 2898 deletions
Download Patch File Download Diff File Expand all files Collapse all files

388
api/classes/xmlcomponent.html
View File

@ -74,19 +74,16 @@
<span class="target">XmlComponent</span>
<ul class="tsd-hierarchy">
<li>
<a href="ignoreifemptyxmlcomponent.html" class="tsd-signature-type">IgnoreIfEmptyXmlComponent</a>
<a href="appproperties.html" class="tsd-signature-type">AppProperties</a>
</li>
<li>
<a href="importedxmlcomponent.html" class="tsd-signature-type">ImportedXmlComponent</a>
<a href="default.html" class="tsd-signature-type">Default</a>
</li>
<li>
<a href="importedrootelementattributes.html" class="tsd-signature-type">ImportedRootElementAttributes</a>
<a href="override.html" class="tsd-signature-type">Override</a>
</li>
<li>
<a href="initializablexmlcomponent.html" class="tsd-signature-type">InitializableXmlComponent</a>
</li>
<li>
<a href="alignment.html" class="tsd-signature-type">Alignment</a>
<a href="contenttypes.html" class="tsd-signature-type">ContentTypes</a>
</li>
<li>
<a href="border.html" class="tsd-signature-type">Border</a>
@ -94,60 +91,6 @@
<li>
<a href="thematicbreak.html" class="tsd-signature-type">ThematicBreak</a>
</li>
<li>
<a href="indent.html" class="tsd-signature-type">Indent</a>
</li>
<li>
<a href="keeplines.html" class="tsd-signature-type">KeepLines</a>
</li>
<li>
<a href="keepnext.html" class="tsd-signature-type">KeepNext</a>
</li>
<li>
<a href="tablegrid.html" class="tsd-signature-type">TableGrid</a>
</li>
<li>
<a href="gridcol.html" class="tsd-signature-type">GridCol</a>
</li>
<li>
<a href="name.html" class="tsd-signature-type">Name</a>
</li>
<li>
<a href="basedon.html" class="tsd-signature-type">BasedOn</a>
</li>
<li>
<a href="next.html" class="tsd-signature-type">Next</a>
</li>
<li>
<a href="link.html" class="tsd-signature-type">Link</a>
</li>
<li>
<a href="uipriority.html" class="tsd-signature-type">UiPriority</a>
</li>
<li>
<a href="unhidewhenused.html" class="tsd-signature-type">UnhideWhenUsed</a>
</li>
<li>
<a href="quickformat.html" class="tsd-signature-type">QuickFormat</a>
</li>
<li>
<a href="tableproperties.html" class="tsd-signature-type">TableProperties</a>
</li>
<li>
<a href="rsid.html" class="tsd-signature-type">RsId</a>
</li>
<li>
<a href="semihidden.html" class="tsd-signature-type">SemiHidden</a>
</li>
<li>
<a href="style.html" class="tsd-signature-type">Style</a>
</li>
<li>
<a href="style.html" class="tsd-signature-type">Style</a>
</li>
<li>
<a href="style.html" class="tsd-signature-type">Style</a>
</li>
<li>
<a href="baseunderline.html" class="tsd-signature-type">BaseUnderline</a>
</li>
@ -220,6 +163,51 @@
<li>
<a href="shadowcomplexscript.html" class="tsd-signature-type">ShadowComplexScript</a>
</li>
<li>
<a href="tablegrid.html" class="tsd-signature-type">TableGrid</a>
</li>
<li>
<a href="gridcol.html" class="tsd-signature-type">GridCol</a>
</li>
<li>
<a href="name.html" class="tsd-signature-type">Name</a>
</li>
<li>
<a href="basedon.html" class="tsd-signature-type">BasedOn</a>
</li>
<li>
<a href="next.html" class="tsd-signature-type">Next</a>
</li>
<li>
<a href="link.html" class="tsd-signature-type">Link</a>
</li>
<li>
<a href="uipriority.html" class="tsd-signature-type">UiPriority</a>
</li>
<li>
<a href="unhidewhenused.html" class="tsd-signature-type">UnhideWhenUsed</a>
</li>
<li>
<a href="quickformat.html" class="tsd-signature-type">QuickFormat</a>
</li>
<li>
<a href="tableproperties.html" class="tsd-signature-type">TableProperties</a>
</li>
<li>
<a href="rsid.html" class="tsd-signature-type">RsId</a>
</li>
<li>
<a href="semihidden.html" class="tsd-signature-type">SemiHidden</a>
</li>
<li>
<a href="style.html" class="tsd-signature-type">Style</a>
</li>
<li>
<a href="style.html" class="tsd-signature-type">Style</a>
</li>
<li>
<a href="style.html" class="tsd-signature-type">Style</a>
</li>
<li>
<a href="styles.html" class="tsd-signature-type">Styles</a>
</li>
@ -286,54 +274,6 @@
<li>
<a href="table.html" class="tsd-signature-type">Table</a>
</li>
<li>
<a href="footnotereference.html" class="tsd-signature-type">FootnoteReference</a>
</li>
<li>
<a href="fieldinstruction.html" class="tsd-signature-type">FieldInstruction</a>
</li>
<li>
<a href="break.html" class="tsd-signature-type">Break</a>
</li>
<li>
<a href="begin.html" class="tsd-signature-type">Begin</a>
</li>
<li>
<a href="separate.html" class="tsd-signature-type">Separate</a>
</li>
<li>
<a href="end.html" class="tsd-signature-type">End</a>
</li>
<li>
<a href="page.html" class="tsd-signature-type">Page</a>
</li>
<li>
<a href="numberofpages.html" class="tsd-signature-type">NumberOfPages</a>
</li>
<li>
<a href="numberofpagessection.html" class="tsd-signature-type">NumberOfPagesSection</a>
</li>
<li>
<a href="text.html" class="tsd-signature-type">Text</a>
</li>
<li>
<a href="run.html" class="tsd-signature-type">Run</a>
</li>
<li>
<a href="symbol.html" class="tsd-signature-type">Symbol</a>
</li>
<li>
<a href="appproperties.html" class="tsd-signature-type">AppProperties</a>
</li>
<li>
<a href="default.html" class="tsd-signature-type">Default</a>
</li>
<li>
<a href="override.html" class="tsd-signature-type">Override</a>
</li>
<li>
<a href="contenttypes.html" class="tsd-signature-type">ContentTypes</a>
</li>
<li>
<a href="levelbase.html" class="tsd-signature-type">LevelBase</a>
</li>
@ -380,16 +320,40 @@
<a href="coreproperties.html" class="tsd-signature-type">CoreProperties</a>
</li>
<li>
<a href="structureddocumenttagcontent.html" class="tsd-signature-type">StructuredDocumentTagContent</a>
<a href="footnotereference.html" class="tsd-signature-type">FootnoteReference</a>
</li>
<li>
<a href="alias.html" class="tsd-signature-type">Alias</a>
<a href="fieldinstruction.html" class="tsd-signature-type">FieldInstruction</a>
</li>
<li>
<a href="structureddocumenttagproperties.html" class="tsd-signature-type">StructuredDocumentTagProperties</a>
<a href="break.html" class="tsd-signature-type">Break</a>
</li>
<li>
<a href="tableofcontents.html" class="tsd-signature-type">TableOfContents</a>
<a href="begin.html" class="tsd-signature-type">Begin</a>
</li>
<li>
<a href="separate.html" class="tsd-signature-type">Separate</a>
</li>
<li>
<a href="end.html" class="tsd-signature-type">End</a>
</li>
<li>
<a href="page.html" class="tsd-signature-type">Page</a>
</li>
<li>
<a href="numberofpages.html" class="tsd-signature-type">NumberOfPages</a>
</li>
<li>
<a href="numberofpagessection.html" class="tsd-signature-type">NumberOfPagesSection</a>
</li>
<li>
<a href="text.html" class="tsd-signature-type">Text</a>
</li>
<li>
<a href="run.html" class="tsd-signature-type">Run</a>
</li>
<li>
<a href="symbol.html" class="tsd-signature-type">Symbol</a>
</li>
<li>
<a href="relationship.html" class="tsd-signature-type">Relationship</a>
@ -397,78 +361,6 @@
<li>
<a href="relationships.html" class="tsd-signature-type">Relationships</a>
</li>
<li>
<a href="columns.html" class="tsd-signature-type">Columns</a>
</li>
<li>
<a href="documentgrid.html" class="tsd-signature-type">DocumentGrid</a>
</li>
<li>
<a href="footerreference.html" class="tsd-signature-type">FooterReference</a>
</li>
<li>
<a href="headerreference.html" class="tsd-signature-type">HeaderReference</a>
</li>
<li>
<a href="linenumbertype.html" class="tsd-signature-type">LineNumberType</a>
</li>
<li>
<a href="pagemargin.html" class="tsd-signature-type">PageMargin</a>
</li>
<li>
<a href="pagenumbertype.html" class="tsd-signature-type">PageNumberType</a>
</li>
<li>
<a href="pagesize.html" class="tsd-signature-type">PageSize</a>
</li>
<li>
<a href="titlepage.html" class="tsd-signature-type">TitlePage</a>
</li>
<li>
<a href="sectionverticalalign.html" class="tsd-signature-type">SectionVerticalAlign</a>
</li>
<li>
<a href="sectionproperties.html" class="tsd-signature-type">SectionProperties</a>
</li>
<li>
<a href="body.html" class="tsd-signature-type">Body</a>
</li>
<li>
<a href="document.html" class="tsd-signature-type">Document</a>
</li>
<li>
<a href="footnoteref.html" class="tsd-signature-type">FootnoteRef</a>
</li>
<li>
<a href="footnote.html" class="tsd-signature-type">Footnote</a>
</li>
<li>
<a href="continuationseperator.html" class="tsd-signature-type">ContinuationSeperator</a>
</li>
<li>
<a href="seperator.html" class="tsd-signature-type">Seperator</a>
</li>
<li>
<a href="footnotes.html" class="tsd-signature-type">FootNotes</a>
</li>
<li>
<a href="compatibility.html" class="tsd-signature-type">Compatibility</a>
</li>
<li>
<a href="updatefields.html" class="tsd-signature-type">UpdateFields</a>
</li>
<li>
<a href="settings.html" class="tsd-signature-type">Settings</a>
</li>
<li>
<a href="paragraphpropertiesdefaults.html" class="tsd-signature-type">ParagraphPropertiesDefaults</a>
</li>
<li>
<a href="runpropertiesdefaults.html" class="tsd-signature-type">RunPropertiesDefaults</a>
</li>
<li>
<a href="documentdefaults.html" class="tsd-signature-type">DocumentDefaults</a>
</li>
<li>
<a href="wrapnone.html" class="tsd-signature-type">WrapNone</a>
</li>
@ -577,6 +469,114 @@
<li>
<a href="tab.html" class="tsd-signature-type">Tab</a>
</li>
<li>
<a href="structureddocumenttagcontent.html" class="tsd-signature-type">StructuredDocumentTagContent</a>
</li>
<li>
<a href="alias.html" class="tsd-signature-type">Alias</a>
</li>
<li>
<a href="structureddocumenttagproperties.html" class="tsd-signature-type">StructuredDocumentTagProperties</a>
</li>
<li>
<a href="tableofcontents.html" class="tsd-signature-type">TableOfContents</a>
</li>
<li>
<a href="columns.html" class="tsd-signature-type">Columns</a>
</li>
<li>
<a href="documentgrid.html" class="tsd-signature-type">DocumentGrid</a>
</li>
<li>
<a href="footerreference.html" class="tsd-signature-type">FooterReference</a>
</li>
<li>
<a href="headerreference.html" class="tsd-signature-type">HeaderReference</a>
</li>
<li>
<a href="linenumbertype.html" class="tsd-signature-type">LineNumberType</a>
</li>
<li>
<a href="pagemargin.html" class="tsd-signature-type">PageMargin</a>
</li>
<li>
<a href="pagenumbertype.html" class="tsd-signature-type">PageNumberType</a>
</li>
<li>
<a href="pagesize.html" class="tsd-signature-type">PageSize</a>
</li>
<li>
<a href="titlepage.html" class="tsd-signature-type">TitlePage</a>
</li>
<li>
<a href="sectionverticalalign.html" class="tsd-signature-type">SectionVerticalAlign</a>
</li>
<li>
<a href="sectionproperties.html" class="tsd-signature-type">SectionProperties</a>
</li>
<li>
<a href="body.html" class="tsd-signature-type">Body</a>
</li>
<li>
<a href="document.html" class="tsd-signature-type">Document</a>
</li>
<li>
<a href="footnoteref.html" class="tsd-signature-type">FootnoteRef</a>
</li>
<li>
<a href="footnote.html" class="tsd-signature-type">Footnote</a>
</li>
<li>
<a href="continuationseperator.html" class="tsd-signature-type">ContinuationSeperator</a>
</li>
<li>
<a href="seperator.html" class="tsd-signature-type">Seperator</a>
</li>
<li>
<a href="footnotes.html" class="tsd-signature-type">FootNotes</a>
</li>
<li>
<a href="compatibility.html" class="tsd-signature-type">Compatibility</a>
</li>
<li>
<a href="updatefields.html" class="tsd-signature-type">UpdateFields</a>
</li>
<li>
<a href="settings.html" class="tsd-signature-type">Settings</a>
</li>
<li>
<a href="paragraphpropertiesdefaults.html" class="tsd-signature-type">ParagraphPropertiesDefaults</a>
</li>
<li>
<a href="runpropertiesdefaults.html" class="tsd-signature-type">RunPropertiesDefaults</a>
</li>
<li>
<a href="documentdefaults.html" class="tsd-signature-type">DocumentDefaults</a>
</li>
<li>
<a href="ignoreifemptyxmlcomponent.html" class="tsd-signature-type">IgnoreIfEmptyXmlComponent</a>
</li>
<li>
<a href="importedxmlcomponent.html" class="tsd-signature-type">ImportedXmlComponent</a>
</li>
<li>
<a href="importedrootelementattributes.html" class="tsd-signature-type">ImportedRootElementAttributes</a>
</li>
<li>
<a href="initializablexmlcomponent.html" class="tsd-signature-type">InitializableXmlComponent</a>
</li>
<li>
<a href="alignment.html" class="tsd-signature-type">Alignment</a>
</li>
<li>
<a href="indent.html" class="tsd-signature-type">Indent</a>
</li>
<li>
<a href="keeplines.html" class="tsd-signature-type">KeepLines</a>
</li>
<li>
<a href="keepnext.html" class="tsd-signature-type">KeepNext</a>
</li>
<li>
<a href="pagebreakbefore.html" class="tsd-signature-type">PageBreakBefore</a>
</li>
@ -659,7 +659,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="basexmlcomponent.html">BaseXmlComponent</a>.<a href="basexmlcomponent.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d147236/src/file/xml-components/xml-component.ts#L9">file/xml-components/xml-component.ts:9</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6d6155c/src/file/xml-components/xml-component.ts#L9">file/xml-components/xml-component.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -686,7 +686,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="basexmlcomponent.html">BaseXmlComponent</a>.<a href="basexmlcomponent.html#isdeleted">IsDeleted</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d147236/src/file/xml-components/base.ts#L14">file/xml-components/base.ts:14</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6d6155c/src/file/xml-components/base.ts#L15">file/xml-components/base.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
@ -706,7 +706,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d147236/src/file/xml-components/xml-component.ts#L43">file/xml-components/xml-component.ts:43</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6d6155c/src/file/xml-components/xml-component.ts#L43">file/xml-components/xml-component.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -729,7 +729,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d147236/src/file/xml-components/xml-component.ts#L49">file/xml-components/xml-component.ts:49</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6d6155c/src/file/xml-components/xml-component.ts#L49">file/xml-components/xml-component.ts:49</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@ -740,16 +740,22 @@
<a name="prepforxml" class="tsd-anchor"></a>
<h3>prep<wbr>For<wbr>Xml</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<li class="tsd-signature tsd-kind-icon">prep<wbr>For<wbr>Xml<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ixmlableobject.html" class="tsd-signature-type">IXmlableObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
<li class="tsd-signature tsd-kind-icon">prep<wbr>For<wbr>Xml<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">?: </span><a href="file.html" class="tsd-signature-type">File</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ixmlableobject.html" class="tsd-signature-type">IXmlableObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="basexmlcomponent.html">BaseXmlComponent</a>.<a href="basexmlcomponent.html#prepforxml">prepForXml</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d147236/src/file/xml-components/xml-component.ts#L16">file/xml-components/xml-component.ts:16</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6d6155c/src/file/xml-components/xml-component.ts#L16">file/xml-components/xml-component.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> file: <a href="file.html" class="tsd-signature-type">File</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ixmlableobject.html" class="tsd-signature-type">IXmlableObject</a>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">undefined</span>