Deploy dolanmiu/docx to github.com/dolanmiu/docx.git:gh-pages

This commit is contained in:
Deployment Bot (from Travis CI)
2018-11-01 02:35:39 +00:00
parent 3366610095
commit 483f7f4ae2
366 changed files with 2995 additions and 2662 deletions

View File

@ -434,11 +434,13 @@
<li class="tsd-kind-interface tsd-is-external"><a href="interfaces/ishapepropertiesattributes.html" class="tsd-kind-icon">IShape<wbr>Properties<wbr>Attributes</a></li>
<li class="tsd-kind-interface tsd-is-external"><a href="interfaces/ispacingproperties.html" class="tsd-kind-icon">ISpacing<wbr>Properties</a></li>
<li class="tsd-kind-interface tsd-is-external"><a href="interfaces/istyleattributes.html" class="tsd-kind-icon">IStyle<wbr>Attributes</a></li>
<li class="tsd-kind-interface tsd-is-external"><a href="interfaces/itablecellshadingattributesproperties.html" class="tsd-kind-icon">ITable<wbr>Cell<wbr>Shading<wbr>Attributes<wbr>Properties</a></li>
<li class="tsd-kind-interface tsd-is-external"><a href="interfaces/itablefloatoptions.html" class="tsd-kind-icon">ITable<wbr>Float<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-is-external"><a href="interfaces/itableofcontentsoptions.html" class="tsd-kind-icon">ITable<wbr>OfContents<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-is-external"><a href="interfaces/itextwrapping.html" class="tsd-kind-icon">IText<wbr>Wrapping</a></li>
<li class="tsd-kind-interface tsd-is-external"><a href="interfaces/iupdatefieldsattributesproperties.html" class="tsd-kind-icon">IUpdate<wbr>Fields<wbr>Attributes<wbr>Properties</a></li>
<li class="tsd-kind-interface tsd-is-external"><a href="interfaces/iverticalpositionoptions.html" class="tsd-kind-icon">IVertical<wbr>Position<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-is-external"><a href="interfaces/ixmlattribute.html" class="tsd-kind-icon">IXml<wbr>Attribute</a></li>
<li class="tsd-kind-interface tsd-is-external"><a href="interfaces/ixmlableobject.html" class="tsd-kind-icon">IXmlable<wbr>Object</a></li>
</ul>
</section>
@ -468,12 +470,6 @@
<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>
<section class="tsd-index-section tsd-is-external">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal tsd-is-external"><a href="globals.html#parseoptions" class="tsd-kind-icon">parse<wbr>Options</a></li>
</ul>
</section>
</div>
</section>
</section>
@ -485,7 +481,7 @@
<div class="tsd-signature tsd-kind-icon">Alignment<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"start"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"end"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"center"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"both"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"distribute"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"left"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"right"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/paragraph/formatting/alignment.ts#L4">file/paragraph/formatting/alignment.ts:4</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/95a9f59/src/file/paragraph/formatting/alignment.ts#L4">file/paragraph/formatting/alignment.ts:4</a></li>
</ul>
</aside>
</section>
@ -495,7 +491,7 @@
<div class="tsd-signature tsd-kind-icon">Attribute<wbr>Map<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/071a8ea/src/file/xml-components/default-attributes.ts#L4">file/xml-components/default-attributes.ts:4</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/95a9f59/src/file/xml-components/default-attributes.ts#L4">file/xml-components/default-attributes.ts:4</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@ -510,7 +506,7 @@
<div class="tsd-signature tsd-kind-icon">Leader<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"dot"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hyphen"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"middleDot"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"none"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"underscore"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/paragraph/formatting/tab-stop.ts#L12">file/paragraph/formatting/tab-stop.ts:12</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/95a9f59/src/file/paragraph/formatting/tab-stop.ts#L12">file/paragraph/formatting/tab-stop.ts:12</a></li>
</ul>
</aside>
</section>
@ -520,7 +516,7 @@
<div class="tsd-signature tsd-kind-icon">Relationship<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/image"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/webSettings"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/header"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/relationships/relationship/relationship.ts#L4">file/relationships/relationship/relationship.ts:4</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/95a9f59/src/file/relationships/relationship/relationship.ts#L4">file/relationships/relationship/relationship.ts:4</a></li>
</ul>
</aside>
</section>
@ -530,7 +526,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/icolumnsattributes.html" class="tsd-signature-type">IColumnsAttributes</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><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">IPageNumberTypeAttributes</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><span class="tsd-signature-type">ITitlePageOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/document/body/section-properties/section-properties.ts#L40">file/document/body/section-properties/section-properties.ts:40</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/95a9f59/src/file/document/body/section-properties/section-properties.ts#L40">file/document/body/section-properties/section-properties.ts:40</a></li>
</ul>
</aside>
</section>
@ -540,7 +536,7 @@
<div class="tsd-signature tsd-kind-icon">Tab<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"left"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"right"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"center"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"bar"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"clear"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"decimal"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"end"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"num"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"start"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/paragraph/formatting/tab-stop.ts#L11">file/paragraph/formatting/tab-stop.ts:11</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/95a9f59/src/file/paragraph/formatting/tab-stop.ts#L11">file/paragraph/formatting/tab-stop.ts:11</a></li>
</ul>
</aside>
</section>
@ -550,7 +546,7 @@
<div class="tsd-signature tsd-kind-icon">Target<wbr>Mode<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"External"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/relationships/relationship/relationship.ts#L20">file/relationships/relationship/relationship.ts:20</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/95a9f59/src/file/relationships/relationship/relationship.ts#L20">file/relationships/relationship/relationship.ts:20</a></li>
</ul>
</aside>
</section>
@ -563,7 +559,7 @@
<div class="tsd-signature tsd-kind-icon">WORKAROUND<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;&quot;</span><span class="tsd-signature-symbol"> =&nbsp;&quot;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/file-properties.ts#L11">file/file-properties.ts:11</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/95a9f59/src/file/file-properties.ts#L11">file/file-properties.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -579,7 +575,7 @@
<div class="tsd-signature tsd-kind-icon">WORKAROUND2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;&quot;</span><span class="tsd-signature-symbol"> =&nbsp;&quot;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/media/data.ts#L24">file/media/data.ts:24</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/95a9f59/src/file/media/data.ts#L24">file/media/data.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -595,7 +591,7 @@
<div class="tsd-signature tsd-kind-icon">WORKAROUND3<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;&quot;</span><span class="tsd-signature-symbol"> =&nbsp;&quot;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/xml-components/xmlable-object.ts#L9">file/xml-components/xmlable-object.ts:9</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/95a9f59/src/file/xml-components/xmlable-object.ts#L12">file/xml-components/xmlable-object.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -612,40 +608,24 @@
<a name="converttoxmlcomponent" class="tsd-anchor"></a>
<h3>convert<wbr>ToXml<wbr>Component</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">convert<wbr>ToXml<wbr>Component<span class="tsd-signature-symbol">(</span>elementName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/importedxmlcomponent.html" class="tsd-signature-type">ImportedXmlComponent</a><span class="tsd-signature-symbol"> | </span><a href="classes/importedxmlcomponent.html" class="tsd-signature-type">ImportedXmlComponent</a><span class="tsd-signature-symbol">[]</span></li>
<li class="tsd-signature tsd-kind-icon">convert<wbr>ToXml<wbr>Component<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">XmlElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/importedxmlcomponent.html" class="tsd-signature-type">ImportedXmlComponent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><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">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/xml-components/imported-xml-component.ts#L28">file/xml-components/imported-xml-component.ts:28</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/95a9f59/src/file/xml-components/imported-xml-component.ts#L10">file/xml-components/imported-xml-component.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the given xml element (in json format) into XmlComponent.
Note: If element is array, them it will return ImportedXmlComponent[]. Example for given:
element = [
{ w:t: &quot;val 1&quot;},
{ w:t: &quot;val 2&quot;}
]
will return
[
ImportedXmlComponent { rootKey: &quot;w:t&quot;, root: [ &quot;val 1&quot; ]},
ImportedXmlComponent { rootKey: &quot;w:t&quot;, root: [ &quot;val 2&quot; ]}
]</p>
<p>Converts the given xml element (in json format) into XmlComponent.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>elementName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>name (rootKey) of the XmlComponent</p>
</div>
</li>
<li>
<h5>element: <span class="tsd-signature-type">any</span></h5>
<h5>element: <span class="tsd-signature-type">XmlElement</span></h5>
<div class="tsd-comment tsd-typography">
<p>the xml element in json presentation</p>
</div>
@ -653,55 +633,14 @@
</ul>
<h4 class="tsd-returns-title">Returns <a href="classes/importedxmlcomponent.html" class="tsd-signature-type">ImportedXmlComponent</a>
<span class="tsd-signature-symbol"> | </span>
<a href="classes/importedxmlcomponent.html" class="tsd-signature-type">ImportedXmlComponent</a><span class="tsd-signature-symbol">[]</span>
<span class="tsd-signature-type">string</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">undefined</span>
</h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-is-external">
<a name="parseoptions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> parse<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">parse<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/071a8ea/src/file/xml-components/imported-xml-component.ts#L6">file/xml-components/imported-xml-component.ts:6</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external">
<a name="parseoptions.attrnodename" class="tsd-anchor"></a>
<h3>attr<wbr>Node<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">attr<wbr>Node<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;_attr&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/xml-components/imported-xml-component.ts#L9">file/xml-components/imported-xml-component.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external">
<a name="parseoptions.attributenameprefix" class="tsd-anchor"></a>
<h3>attribute<wbr>Name<wbr>Prefix</h3>
<div class="tsd-signature tsd-kind-icon">attribute<wbr>Name<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/xml-components/imported-xml-component.ts#L8">file/xml-components/imported-xml-component.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external">
<a name="parseoptions.ignoreattributes" class="tsd-anchor"></a>
<h3>ignore<wbr>Attributes</h3>
<div class="tsd-signature tsd-kind-icon">ignore<wbr>Attributes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/071a8ea/src/file/xml-components/imported-xml-component.ts#L7">file/xml-components/imported-xml-component.ts:7</a></li>
</ul>
</aside>
</section>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
@ -1781,6 +1720,9 @@
<li class=" tsd-kind-interface tsd-is-external">
<a href="interfaces/istyleattributes.html" class="tsd-kind-icon">IStyle<wbr>Attributes</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="interfaces/itablecellshadingattributesproperties.html" class="tsd-kind-icon">ITable<wbr>Cell<wbr>Shading<wbr>Attributes<wbr>Properties</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="interfaces/itablefloatoptions.html" class="tsd-kind-icon">ITable<wbr>Float<wbr>Options</a>
</li>
@ -1796,6 +1738,9 @@
<li class=" tsd-kind-interface tsd-is-external">
<a href="interfaces/iverticalpositionoptions.html" class="tsd-kind-icon">IVertical<wbr>Position<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="interfaces/ixmlattribute.html" class="tsd-kind-icon">IXml<wbr>Attribute</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="interfaces/ixmlableobject.html" class="tsd-kind-icon">IXmlable<wbr>Object</a>
</li>
@ -1832,9 +1777,6 @@
<li class=" tsd-kind-function tsd-is-external">
<a href="globals.html#converttoxmlcomponent" class="tsd-kind-icon">convert<wbr>ToXml<wbr>Component</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-external">
<a href="globals.html#parseoptions" class="tsd-kind-icon">parse<wbr>Options</a>
</li>
</ul>
</nav>
</div>