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-09-29 03:48:33 +00:00
parent 588f2f312d
commit 437ae3c3c4
409 changed files with 3304 additions and 4464 deletions
Download Patch File Download Diff File Expand all files Collapse all files

242
api/classes/tablecell.html
View File

@ -88,25 +88,23 @@
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="tablecell.html#options" class="tsd-kind-icon">options</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited tsd-is-external">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="tablecell.html#borders" class="tsd-kind-icon">Borders</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="tablecell.html#isdeleted" class="tsd-kind-icon">Is<wbr>Deleted</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="tablecell.html#properties" class="tsd-kind-icon">Properties</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="tablecell.html#add" class="tsd-kind-icon">add</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="tablecell.html#addchildelement" class="tsd-kind-icon">add<wbr>Child<wbr>Element</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="tablecell.html#addgridspan" class="tsd-kind-icon">add<wbr>Grid<wbr>Span</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="tablecell.html#addverticalmerge" class="tsd-kind-icon">add<wbr>Vertical<wbr>Merge</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="tablecell.html#delete" class="tsd-kind-icon">delete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="tablecell.html#prepforxml" class="tsd-kind-icon">prep<wbr>For<wbr>Xml</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="tablecell.html#setmargins" class="tsd-kind-icon">set<wbr>Margins</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="tablecell.html#setshading" class="tsd-kind-icon">set<wbr>Shading</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="tablecell.html#setverticalalign" class="tsd-kind-icon">set<wbr>Vertical<wbr>Align</a></li>
</ul>
</section>
</div>
@ -118,40 +116,42 @@
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<li class="tsd-signature tsd-kind-icon">new <wbr>Table<wbr>Cell<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tablecell.html" class="tsd-signature-type">TableCell</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Table<wbr>Cell<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/itablecelloptions.html" class="tsd-signature-type">ITableCellOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tablecell.html" class="tsd-signature-type">TableCell</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="xmlcomponent.html">XmlComponent</a>.<a href="xmlcomponent.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/993f8f8/src/file/table/table-cell/table-cell.ts#L16">file/table/table-cell/table-cell.ts:16</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2b874e3/src/file/table/table-cell/table-cell.ts#L45">file/table/table-cell/table-cell.ts:45</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="../interfaces/itablecelloptions.html" class="tsd-signature-type">ITableCellOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tablecell.html" class="tsd-signature-type">TableCell</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
<a name="borders" class="tsd-anchor"></a>
<h3>Borders</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Borders<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tablecellborders.html" class="tsd-signature-type">TableCellBorders</a></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/993f8f8/src/file/table/table-cell/table-cell.ts#L70">file/table/table-cell/table-cell.ts:70</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="tablecellborders.html" class="tsd-signature-type">TableCellBorders</a></h4>
</li>
</ul>
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="options" class="tsd-anchor"></a>
<h3>options</h3>
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/itablecelloptions.html" class="tsd-signature-type">ITableCellOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2b874e3/src/file/table/table-cell/table-cell.ts#L47">file/table/table-cell/table-cell.ts:47</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="isdeleted" class="tsd-anchor"></a>
<h3>Is<wbr>Deleted</h3>
@ -163,56 +163,16 @@
<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/993f8f8/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/2b874e3/src/file/xml-components/base.ts#L14">file/xml-components/base.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
<a name="properties" class="tsd-anchor"></a>
<h3>Properties</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Properties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tablecellproperties.html" class="tsd-signature-type">TableCellProperties</a></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/993f8f8/src/file/table/table-cell/table-cell.ts#L74">file/table/table-cell/table-cell.ts:74</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="tablecellproperties.html" class="tsd-signature-type">TableCellProperties</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="add" class="tsd-anchor"></a>
<h3>add</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><a href="paragraph.html" class="tsd-signature-type">Paragraph</a><span class="tsd-signature-symbol"> | </span><a href="table.html" class="tsd-signature-type">Table</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tablecell.html" class="tsd-signature-type">TableCell</a></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/993f8f8/src/file/table/table-cell/table-cell.ts#L25">file/table/table-cell/table-cell.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>item: <a href="paragraph.html" class="tsd-signature-type">Paragraph</a><span class="tsd-signature-symbol"> | </span><a href="table.html" class="tsd-signature-type">Table</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tablecell.html" class="tsd-signature-type">TableCell</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="addchildelement" class="tsd-anchor"></a>
<h3>add<wbr>Child<wbr>Element</h3>
@ -224,7 +184,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="xmlcomponent.html">XmlComponent</a>.<a href="xmlcomponent.html#addchildelement">addChildElement</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/993f8f8/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/2b874e3/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>
@ -237,52 +197,6 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addgridspan" class="tsd-anchor"></a>
<h3>add<wbr>Grid<wbr>Span</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Grid<wbr>Span<span class="tsd-signature-symbol">(</span>cellSpan<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><a href="tablecell.html" class="tsd-signature-type">TableCell</a></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/993f8f8/src/file/table/table-cell/table-cell.ts#L46">file/table/table-cell/table-cell.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>cellSpan: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tablecell.html" class="tsd-signature-type">TableCell</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addverticalmerge" class="tsd-anchor"></a>
<h3>add<wbr>Vertical<wbr>Merge</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Vertical<wbr>Merge<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../enums/vmergetype.html" class="tsd-signature-type">VMergeType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tablecell.html" class="tsd-signature-type">TableCell</a></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/993f8f8/src/file/table/table-cell/table-cell.ts#L52">file/table/table-cell/table-cell.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <a href="../enums/vmergetype.html" class="tsd-signature-type">VMergeType</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tablecell.html" class="tsd-signature-type">TableCell</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="delete" class="tsd-anchor"></a>
<h3>delete</h3>
@ -294,7 +208,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="xmlcomponent.html">XmlComponent</a>.<a href="xmlcomponent.html#delete">delete</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/993f8f8/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/2b874e3/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>
@ -312,7 +226,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="xmlcomponent.html">XmlComponent</a>.<a href="xmlcomponent.html#prepforxml">prepForXml</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/993f8f8/src/file/table/table-cell/table-cell.ts#L31">file/table/table-cell/table-cell.ts:31</a></li>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/2b874e3/src/file/table/table-cell/table-cell.ts#L105">file/table/table-cell/table-cell.ts:105</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ixmlableobject.html" class="tsd-signature-type">IXmlableObject</a>
@ -322,75 +236,6 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="setmargins" class="tsd-anchor"></a>
<h3>set<wbr>Margins</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">set<wbr>Margins<span class="tsd-signature-symbol">(</span>margins<span class="tsd-signature-symbol">: </span><a href="../interfaces/itablecellmarginoptions.html" class="tsd-signature-type">ITableCellMarginOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tablecell.html" class="tsd-signature-type">TableCell</a></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/993f8f8/src/file/table/table-cell/table-cell.ts#L58">file/table/table-cell/table-cell.ts:58</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>margins: <a href="../interfaces/itablecellmarginoptions.html" class="tsd-signature-type">ITableCellMarginOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tablecell.html" class="tsd-signature-type">TableCell</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="setshading" class="tsd-anchor"></a>
<h3>set<wbr>Shading</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">set<wbr>Shading<span class="tsd-signature-symbol">(</span>attrs<span class="tsd-signature-symbol">: </span><a href="../interfaces/itableshadingattributesproperties.html" class="tsd-signature-type">ITableShadingAttributesProperties</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tablecell.html" class="tsd-signature-type">TableCell</a></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/993f8f8/src/file/table/table-cell/table-cell.ts#L64">file/table/table-cell/table-cell.ts:64</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>attrs: <a href="../interfaces/itableshadingattributesproperties.html" class="tsd-signature-type">ITableShadingAttributesProperties</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tablecell.html" class="tsd-signature-type">TableCell</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="setverticalalign" class="tsd-anchor"></a>
<h3>set<wbr>Vertical<wbr>Align</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">set<wbr>Vertical<wbr>Align<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VerticalAlign</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tablecell.html" class="tsd-signature-type">TableCell</a></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/993f8f8/src/file/table/table-cell/table-cell.ts#L40">file/table/table-cell/table-cell.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <span class="tsd-signature-type">VerticalAlign</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tablecell.html" class="tsd-signature-type">TableCell</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@ -411,42 +256,21 @@
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<a href="tablecell.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
<a href="tablecell.html#borders" class="tsd-kind-icon">Borders</a>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="tablecell.html#options" class="tsd-kind-icon">options</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="tablecell.html#isdeleted" class="tsd-kind-icon">Is<wbr>Deleted</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
<a href="tablecell.html#properties" class="tsd-kind-icon">Properties</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="tablecell.html#add" class="tsd-kind-icon">add</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="tablecell.html#addchildelement" class="tsd-kind-icon">add<wbr>Child<wbr>Element</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="tablecell.html#addgridspan" class="tsd-kind-icon">add<wbr>Grid<wbr>Span</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="tablecell.html#addverticalmerge" class="tsd-kind-icon">add<wbr>Vertical<wbr>Merge</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="tablecell.html#delete" class="tsd-kind-icon">delete</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<a href="tablecell.html#prepforxml" class="tsd-kind-icon">prep<wbr>For<wbr>Xml</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="tablecell.html#setmargins" class="tsd-kind-icon">set<wbr>Margins</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="tablecell.html#setshading" class="tsd-kind-icon">set<wbr>Shading</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="tablecell.html#setverticalalign" class="tsd-kind-icon">set<wbr>Vertical<wbr>Align</a>
</li>
</ul>
</li>
</ul>