2021-10-08 16:51:17 +00:00
|
|
|
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ITableFloatOptions | 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="ITableFloatOptions.html">ITableFloatOptions</a></li></ul><h1>Interface ITableFloatOptions</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><span class="target">ITableFloatOptions</span></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#absoluteHorizontalPosition" class="tsd-kind-icon">absolute<wbr/>Horizontal<wbr/>Position</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#absoluteVerticalPosition" class="tsd-kind-icon">absolute<wbr/>Vertical<wbr/>Position</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#bottomFromText" class="tsd-kind-icon">bottom<wbr/>From<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#horizontalAnchor" class="tsd-kind-icon">horizontal<wbr/>Anchor</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#leftFromText" class="tsd-kind-icon">left<wbr/>From<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#overlap" class="tsd-kind-icon">overlap</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#relativeHorizontalPosition" class="tsd-kind-icon">relative<wbr/>Horizontal<wbr/>Position</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#relativeVerticalPosition" class="tsd-kind-icon">relative<wbr/>Vertical<wbr/>Position</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#rightFromText" class="tsd-kind-icon">right<wbr/>From<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#topFromText"
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>Specifies an absolute horizontal position for the table, relative to the horizontalAnchor.
|
|
|
|
|
The value is in twentieths of a point. Note that the value can be negative, in which case the
|
|
|
|
|
table is positioned before the anchor object in the direction of horizontal text flow.
|
|
|
|
|
If relativeHorizontalPosition is also specified, then the absoluteHorizontalPosition attribute is ignored.
|
|
|
|
|
If the attribute is omitted, the value is assumed to be zero.</p>
|
2021-10-08 16:51:17 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="absoluteVerticalPosition" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> absolute<wbr/>Vertical<wbr/>Position</h3><div class="tsd-signature tsd-kind-icon">absolute<wbr/>Vertical<wbr/>Position<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/abbd620/src/file/table/table-properties/table-float-properties.ts#L78">src/file/table/table-properties/table-float-properties.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>Specifies an absolute vertical position for the table, relative to the verticalAnchor anchor.
|
|
|
|
|
The value is in twentieths of a point. Note that the value can be negative, in which case the table is
|
|
|
|
|
positioned before the anchor object in the direction of vertical text flow.
|
|
|
|
|
If relativeVerticalPosition is also specified, then the absoluteVerticalPosition attribute is ignored.
|
|
|
|
|
If the attribute is omitted, the value is assumed to be zero.</p>
|
2021-10-08 16:51:17 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="bottomFromText" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> bottom<wbr/>From<wbr/>Text</h3><div class="tsd-signature tsd-kind-icon">bottom<wbr/>From<wbr/>Text<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/abbd620/src/file/table/table-properties/table-float-properties.ts#L96">src/file/table/table-properties/table-float-properties.ts:96</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>Specifies the minimun distance to be maintained between the table and the top of text in the paragraph
|
|
|
|
|
below the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.</p>
|
2021-10-08 16:51:17 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="horizontalAnchor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> horizontal<wbr/>Anchor</h3><div class="tsd-signature tsd-kind-icon">horizontal<wbr/>Anchor<span class="tsd-signature-symbol">?:</span> <a href="../enums/TableAnchorType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TableAnchorType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/abbd620/src/file/table/table-properties/table-float-properties.ts#L38">src/file/table/table-properties/table-float-properties.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>Specifies the horizontal anchor or the base object from which the horizontal positioning in the
|
|
|
|
|
tblpX or tblpXSpec attribute should be determined.
|
|
|
|
|
margin - relative to the vertical edge of the text margin before any text runs (left edge for left-to-right paragraphs)
|
|
|
|
|
page - relative to the vertical edge of the page before any text runs (left edge for left-to-right paragraphs)
|
|
|
|
|
text - relative to the vertical edge of the text margin for the column in which the anchor paragraph is located
|
|
|
|
|
If omitted, the value is assumed to be page.</p>
|
2021-10-08 16:51:17 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="leftFromText" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> left<wbr/>From<wbr/>Text</h3><div class="tsd-signature tsd-kind-icon">left<wbr/>From<wbr/>Text<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/abbd620/src/file/table/table-properties/table-float-properties.ts#L108">src/file/table/table-properties/table-float-properties.ts:108</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>Specifies the minimun distance to be maintained between the table and the edge of text in the paragraph
|
|
|
|
|
to the left of the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.</p>
|
2021-10-08 16:51:17 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="overlap" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> overlap</h3><div class="tsd-signature tsd-kind-icon">overlap<span class="tsd-signature-symbol">?:</span> <a href="../enums/OverlapType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">OverlapType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/abbd620/src/file/table/table-properties/table-float-properties.ts#L115">src/file/table/table-properties/table-float-properties.ts:115</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="relativeHorizontalPosition" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> relative<wbr/>Horizontal<wbr/>Position</h3><div class="tsd-signature tsd-kind-icon">relative<wbr/>Horizontal<wbr/>Position<span class="tsd-signature-symbol">?:</span> <a href="../enums/RelativeHorizontalPosition.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RelativeHorizontalPosition</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/abbd620/src/file/table/table-properties/table-float-properties.ts#L59">src/file/table/table-properties/table-float-properties.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>Specifies a relative horizontal position for the table, relative to the horizontalAnchor attribute.
|
|
|
|
|
This will supersede the absoluteHorizontalPosition attribute.
|
|
|
|
|
Possible values are:
|
|
|
|
|
center - the table should be horizontally centered with respect to the anchor
|
|
|
|
|
inside - the table should be inside of the anchor
|
|
|
|
|
left - the table should be left aligned with respect to the anchor
|
|
|
|
|
outside - the table should be outside of the anchor
|
|
|
|
|
right - the table should be right aligned with respect to the anchor</p>
|
2021-10-08 16:51:17 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="relativeVerticalPosition" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> relative<wbr/>Vertical<wbr/>Position</h3><div class="tsd-signature tsd-kind-icon">relative<wbr/>Vertical<wbr/>Position<span class="tsd-signature-symbol">?:</span> <a href="../enums/RelativeVerticalPosition.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RelativeVerticalPosition</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/abbd620/src/file/table/table-properties/table-float-properties.ts#L90">src/file/table/table-properties/table-float-properties.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>Specifies a relative vertical position for the table, relative to the verticalAnchor attribute.
|
|
|
|
|
This will supersede the absoluteVerticalPosition attribute. Possible values are:
|
|
|
|
|
center - the table should be vertically centered with respect to the anchor
|
|
|
|
|
inside - the table should be vertically aligned to the edge of the anchor and inside the anchor
|
|
|
|
|
bottom - the table should be vertically aligned to the bottom edge of the anchor
|
|
|
|
|
outside - the table should be vertically aligned to the edge of the anchor and outside the anchor
|
|
|
|
|
inline - the table should be vertically aligned in line with the surrounding text (so as to not allow any text wrapping around it)
|
|
|
|
|
top - the table should be vertically aligned to the top edge of the anchor</p>
|
2021-10-08 16:51:17 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="rightFromText" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> right<wbr/>From<wbr/>Text</h3><div class="tsd-signature tsd-kind-icon">right<wbr/>From<wbr/>Text<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/abbd620/src/file/table/table-properties/table-float-properties.ts#L114">src/file/table/table-properties/table-float-properties.ts:114</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>Specifies the minimun distance to be maintained between the table and the edge of text in the paragraph
|
|
|
|
|
to the right of the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.</p>
|
2021-10-08 16:51:17 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="topFromText" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> top<wbr/>From<wbr/>Text</h3><div class="tsd-signature tsd-kind-icon">top<wbr/>From<wbr/>Text<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/abbd620/src/file/table/table-properties/table-float-properties.ts#L102">src/file/table/table-properties/table-float-properties.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>Specifies the minimun distance to be maintained between the table and the bottom edge of text in the paragraph
|
|
|
|
|
above the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.</p>
|
2021-10-08 16:51:17 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="verticalAnchor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> vertical<wbr/>Anchor</h3><div class="tsd-signature tsd-kind-icon">vertical<wbr/>Anchor<span class="tsd-signature-symbol">?:</span> <a href="../enums/TableAnchorType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TableAnchorType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/abbd620/src/file/table/table-properties/table-float-properties.ts#L69">src/file/table/table-properties/table-float-properties.ts:69</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>Specifies the vertical anchor or the base object from which the vertical positioning
|
|
|
|
|
in the absoluteVerticalPosition attribute should be determined. Possible values are:
|
|
|
|
|
margin - relative to the horizontal edge of the text margin before any text runs (top edge for top-to-bottom paragraphs)
|
|
|
|
|
page - relative to the horizontal edge of the page before any text runs (top edge for top-to-bottom paragraphs)
|
|
|
|
|
text - relative to the horizontal edge of the text margin for the column in which the anchor paragraph is located
|
|
|
|
|
If omitted, the value is assumed to be page.</p>
|
|
|
|
|
</div></div></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-interface"><a href="ITableFloatOptions.html" class="tsd-kind-icon">ITable<wbr/>Float<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#absoluteHorizontalPosition" class="tsd-kind-icon">absolute<wbr/>Horizontal<wbr/>Position</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#absoluteVerticalPosition" class="tsd-kind-icon">absolute<wbr/>Vertical<wbr/>Position</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#bottomFromText" class="tsd-kind-icon">bottom<wbr/>From<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#horizontalAnchor" class="tsd-kind-icon">horizontal<wbr/>Anchor</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#leftFromText" class="tsd-kind-icon">left<wbr/>From<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#overlap" class="tsd-kind-icon">overlap</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#relativeHorizontalPosition" class="tsd-kind-icon">relative<wbr/>Horizontal<wbr/>Position</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#relativeVerticalPosition" class="tsd-kind-icon">relative<wbr/>Vertical<wbr/>Position</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#rightFromText" class="tsd-kind-icon">right<wbr/>From<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#topFromText" class="tsd-kind-icon">top<wbr/>From<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableFloatOptions.html#verticalAnchor" class="tsd-kind-icon">vertical<wbr/>Anchor</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>
|
