48 lines
21 KiB
HTML
48 lines
21 KiB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base=".."><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">docx</a></li><li><a href="ITableFloatOptions.html">ITableFloatOptions</a></li></ul><h1>Type Alias ITableFloatOptions</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">ITableFloatOptions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">absoluteHorizontalPosition</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="UniversalMeasure.html" class="tsd-signature-type tsd-kind-type-alias">UniversalMeasure</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">absoluteVerticalPosition</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="UniversalMeasure.html" class="tsd-signature-type tsd-kind-type-alias">UniversalMeasure</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">bottomFromText</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="PositiveUniversalMeasure.html" class="tsd-signature-type tsd-kind-type-alias">PositiveUniversalMeasure</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">horizontalAnchor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/TableAnchorType.html" class="tsd-signature-type tsd-kind-variable">TableAnchorType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/TableAnchorType.html" class="tsd-signature-type tsd-kind-variable">TableAnchorType</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">leftFromText</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="PositiveUniversalMeasure.html" class="tsd-signature-type tsd-kind-type-alias">PositiveUniversalMeasure</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">overlap</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/OverlapType.html" class="tsd-signature-type tsd-kind-variable">OverlapType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/OverlapType.html" class="tsd-signature-type tsd-kind-variable">OverlapType</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">relativeHorizontalPosition</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/RelativeHorizontalPosition.html" class="tsd-signature-type tsd-kind-variable">RelativeHorizontalPosition</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/RelativeHorizontalPosition.html" class="tsd-signature-type tsd-kind-variable">RelativeHorizontalPosition</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">relativeVerticalPosition</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/RelativeVerticalPosition.html" class="tsd-signature-type tsd-kind-variable">RelativeVerticalPosition</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/RelativeVerticalPosition.html" class="tsd-signature-type tsd-kind-variable">RelativeVerticalPosition</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">rightFromText</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="PositiveUniversalMeasure.html" class="tsd-signature-type tsd-kind-type-alias">PositiveUniversalMeasure</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">topFromText</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="PositiveUniversalMeasure.html" class="tsd-signature-type tsd-kind-type-alias">PositiveUniversalMeasure</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">verticalAnchor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/TableAnchorType.html" class="tsd-signature-type tsd-kind-variable">TableAnchorType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/TableAnchorType.html" class="tsd-signature-type tsd-kind-variable">TableAnchorType</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">absoluteHorizontalPosition</span><a id="__typeabsolutehorizontalposition" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="UniversalMeasure.html" class="tsd-signature-type tsd-kind-type-alias">UniversalMeasure</a></h5><div class="tsd-comment tsd-typography"><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>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">absoluteVerticalPosition</span><a id="__typeabsoluteverticalposition" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="UniversalMeasure.html" class="tsd-signature-type tsd-kind-type-alias">UniversalMeasure</a></h5><div class="tsd-comment tsd-typography"><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>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">bottomFromText</span><a id="__typebottomfromtext" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="PositiveUniversalMeasure.html" class="tsd-signature-type tsd-kind-type-alias">PositiveUniversalMeasure</a></h5><div class="tsd-comment tsd-typography"><p>Specifies the minimum 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>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">horizontalAnchor</span><a id="__typehorizontalanchor" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-keyword">typeof</span> <a href="../variables/TableAnchorType.html" class="tsd-signature-type tsd-kind-variable">TableAnchorType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/TableAnchorType.html" class="tsd-signature-type tsd-kind-variable">TableAnchorType</a><span class="tsd-signature-symbol">]</span></h5><div class="tsd-comment tsd-typography"><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>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">leftFromText</span><a id="__typeleftfromtext" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="PositiveUniversalMeasure.html" class="tsd-signature-type tsd-kind-type-alias">PositiveUniversalMeasure</a></h5><div class="tsd-comment tsd-typography"><p>Specifies the minimum 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>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">overlap</span><a id="__typeoverlap" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-keyword">typeof</span> <a href="../variables/OverlapType.html" class="tsd-signature-type tsd-kind-variable">OverlapType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/OverlapType.html" class="tsd-signature-type tsd-kind-variable">OverlapType</a><span class="tsd-signature-symbol">]</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">relativeHorizontalPosition</span><a id="__typerelativehorizontalposition" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-keyword">typeof</span> <a href="../variables/RelativeHorizontalPosition.html" class="tsd-signature-type tsd-kind-variable">RelativeHorizontalPosition</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/RelativeHorizontalPosition.html" class="tsd-signature-type tsd-kind-variable">RelativeHorizontalPosition</a><span class="tsd-signature-symbol">]</span></h5><div class="tsd-comment tsd-typography"><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>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">relativeVerticalPosition</span><a id="__typerelativeverticalposition" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-keyword">typeof</span> <a href="../variables/RelativeVerticalPosition.html" class="tsd-signature-type tsd-kind-variable">RelativeVerticalPosition</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/RelativeVerticalPosition.html" class="tsd-signature-type tsd-kind-variable">RelativeVerticalPosition</a><span class="tsd-signature-symbol">]</span></h5><div class="tsd-comment tsd-typography"><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>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">rightFromText</span><a id="__typerightfromtext" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="PositiveUniversalMeasure.html" class="tsd-signature-type tsd-kind-type-alias">PositiveUniversalMeasure</a></h5><div class="tsd-comment tsd-typography"><p>Specifies the minimum 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>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">topFromText</span><a id="__typetopfromtext" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="PositiveUniversalMeasure.html" class="tsd-signature-type tsd-kind-type-alias">PositiveUniversalMeasure</a></h5><div class="tsd-comment tsd-typography"><p>Specifies the minimum 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>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">verticalAnchor</span><a id="__typeverticalanchor" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-keyword">typeof</span> <a href="../variables/TableAnchorType.html" class="tsd-signature-type tsd-kind-variable">TableAnchorType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/TableAnchorType.html" class="tsd-signature-type tsd-kind-variable">TableAnchorType</a><span class="tsd-signature-symbol">]</span></h5><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b2b23bdc1c01992c508e76946e541ed1f5995810/src/file/table/table-properties/table-float-properties.ts#L38">file/table/table-properties/table-float-properties.ts:38</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">docx</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|