1 line
19 KiB
HTML
1 line
19 KiB
HTML
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>TableRow | docx</title><meta name="description" content="Documentation for docx"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">docx</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">docx</a></li><li><a href="TableRow.html">TableRow</a></li></ul><h1>Class TableRow</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="XmlComponent.html" class="tsd-signature-type" data-tsd-kind="Class">XmlComponent</a><ul class="tsd-hierarchy"><li><span class="target">TableRow</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="TableRow.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="TableRow.html#CellCount" class="tsd-kind-icon">Cell<wbr/>Count</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="TableRow.html#cells" class="tsd-kind-icon">cells</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="TableRow.html#addCellToColumnIndex" class="tsd-kind-icon">add<wbr/>Cell<wbr/>To<wbr/>Column<wbr/>Index</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TableRow.html#addCellToIndex" class="tsd-kind-icon">add<wbr/>Cell<wbr/>To<wbr/>Index</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TableRow.html#addChildElement" class="tsd-kind-icon">add<wbr/>Child<wbr/>Element</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TableRow.html#columnIndexToRootIndex" class="tsd-kind-icon">column<wbr/>Index<wbr/>To<wbr/>Root<wbr/>Index</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TableRow.html#prepForXml" class="tsd-kind-icon">prep<wbr/>For<wbr/>Xml</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TableRow.html#rootIndexToColumnIndex" class="tsd-kind-icon">root<wbr/>Index<wbr/>To<wbr/>Column<wbr/>Index</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Table<wbr/>Row<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ITableRowOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ITableRowOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TableRow.html" class="tsd-signature-type" data-tsd-kind="Class">TableRow</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/ea54f35/src/file/table/table-row/table-row.ts#L10">src/file/table/table-row/table-row.ts:10</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/ITableRowOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ITableRowOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="TableRow.html" class="tsd-signature-type" data-tsd-kind="Class">TableRow</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="CellCount" class="tsd-anchor"></a><h3>Cell<wbr/>Count</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> CellCount<span class="tsd-signature-symbol">(</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/ea54f35/src/file/table/table-row/table-row.ts#L19">src/file/table/table-row/table-row.ts:19</a></li></ul></aside><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-get-signature tsd-parent-kind-class"><a name="cells" class="tsd-anchor"></a><h3>cells</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> cells<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" data-tsd-kind="Class">TableCell</a><span class="tsd-signature-symbol">[]</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/ea54f35/src/file/table/table-row/table-row.ts#L23">src/file/table/table-row/table-row.ts:23</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="TableCell.html" class="tsd-signature-type" data-tsd-kind="Class">TableCell</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="addCellToColumnIndex" class="tsd-anchor"></a><h3>add<wbr/>Cell<wbr/>To<wbr/>Column<wbr/>Index</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Cell<wbr/>To<wbr/>Column<wbr/>Index<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">: </span><a href="TableCell.html" class="tsd-signature-type" data-tsd-kind="Class">TableCell</a>, columnIndex<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">void</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/ea54f35/src/file/table/table-row/table-row.ts#L32">src/file/table/table-row/table-row.ts:32</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <a href="TableCell.html" class="tsd-signature-type" data-tsd-kind="Class">TableCell</a></h5></li><li><h5>columnIndex: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="addCellToIndex" class="tsd-anchor"></a><h3>add<wbr/>Cell<wbr/>To<wbr/>Index</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Cell<wbr/>To<wbr/>Index<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">: </span><a href="TableCell.html" class="tsd-signature-type" data-tsd-kind="Class">TableCell</a>, index<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">void</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/ea54f35/src/file/table/table-row/table-row.ts#L27">src/file/table/table-row/table-row.ts:27</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <a href="TableCell.html" class="tsd-signature-type" data-tsd-kind="Class">TableCell</a></h5></li><li><h5>index: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a name="addChildElement" class="tsd-anchor"></a><h3>add<wbr/>Child<wbr/>Element</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">add<wbr/>Child<wbr/>Element<span class="tsd-signature-symbol">(</span>child<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="XmlComponent.html" class="tsd-signature-type" data-tsd-kind="Class">XmlComponent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="XmlComponent.html" class="tsd-signature-type" data-tsd-kind="Class">XmlComponent</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><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/ea54f35/src/file/xml-components/xml-component.ts#L34">src/file/xml-components/xml-component.ts:34</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>child: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="XmlComponent.html" class="tsd-signature-type" data-tsd-kind="Class">XmlComponent</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="XmlComponent.html" class="tsd-signature-type" data-tsd-kind="Class">XmlComponent</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="columnIndexToRootIndex" class="tsd-anchor"></a><h3>column<wbr/>Index<wbr/>To<wbr/>Root<wbr/>Index</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">column<wbr/>Index<wbr/>To<wbr/>Root<wbr/>Index<span class="tsd-signature-symbol">(</span>columnIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, allowEndNewCell<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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/ea54f35/src/file/table/table-row/table-row.ts#L51">src/file/table/table-row/table-row.ts:51</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>columnIndex: <span class="tsd-signature-type">number</span></h5></li><li><h5>allowEndNewCell: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</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-method tsd-parent-kind-class tsd-is-inherited"><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-inherited"><li class="tsd-signature tsd-kind-icon">prep<wbr/>For<wbr/>Xml<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/IContext.html" class="tsd-signature-type" data-tsd-kind="Interface">IContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/IXmlableObject.html" class="tsd-signature-type" data-tsd-kind="Interface">IXmlableObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <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/ea54f35/src/file/xml-components/xml-component.ts#L15">src/file/xml-components/xml-component.ts:15</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>context: <a href="../interfaces/IContext.html" class="tsd-signature-type" data-tsd-kind="Interface">IContext</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/IXmlableObject.html" class="tsd-signature-type" data-tsd-kind="Interface">IXmlableObject</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="rootIndexToColumnIndex" class="tsd-anchor"></a><h3>root<wbr/>Index<wbr/>To<wbr/>Column<wbr/>Index</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">root<wbr/>Index<wbr/>To<wbr/>Column<wbr/>Index<span class="tsd-signature-symbol">(</span>rootIndex<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/ea54f35/src/file/table/table-row/table-row.ts#L37">src/file/table/table-row/table-row.ts:37</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>rootIndex: <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></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="TableRow.html" class="tsd-kind-icon">Table<wbr/>Row</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="TableRow.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="TableRow.html#CellCount" class="tsd-kind-icon">Cell<wbr/>Count</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="TableRow.html#cells" class="tsd-kind-icon">cells</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TableRow.html#addCellToColumnIndex" class="tsd-kind-icon">add<wbr/>Cell<wbr/>To<wbr/>Column<wbr/>Index</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TableRow.html#addCellToIndex" class="tsd-kind-icon">add<wbr/>Cell<wbr/>To<wbr/>Index</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TableRow.html#addChildElement" class="tsd-kind-icon">add<wbr/>Child<wbr/>Element</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TableRow.html#columnIndexToRootIndex" class="tsd-kind-icon">column<wbr/>Index<wbr/>To<wbr/>Root<wbr/>Index</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TableRow.html#prepForXml" class="tsd-kind-icon">prep<wbr/>For<wbr/>Xml</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TableRow.html#rootIndexToColumnIndex" class="tsd-kind-icon">root<wbr/>Index<wbr/>To<wbr/>Column<wbr/>Index</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |