12 lines
13 KiB
HTML
12 lines
13 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>HorizontalPositionRelativeFrom | 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(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">docx</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">HorizontalPositionRelativeFrom</a></li></ul><h1>Variable HorizontalPositionRelativeFrom<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">HorizontalPositionRelativeFrom</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">CHARACTER</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"character"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">COLUMN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"column"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">INSIDE_MARGIN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"insideMargin"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">LEFT_MARGIN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"leftMargin"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">MARGIN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"margin"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">OUTSIDE_MARGIN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"outsideMargin"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">PAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"page"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">RIGHT_MARGIN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"rightMargin"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Horizontal Relative Positioning</p>
|
||
<p>Reference: <a href="https://www.datypic.com/sc/ooxml/t-wp_ST_RelFromH.html">https://www.datypic.com/sc/ooxml/t-wp_ST_RelFromH.html</a></p>
|
||
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5 id="character"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">CHARACTER</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"character"</span></h5><div class="tsd-comment tsd-typography"><h2 id="character-1" class="tsd-anchor-link">Character<a href="#character-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Specifies that the horizontal positioning shall be relative to the position of the anchor within its run content.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="column"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">COLUMN</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"column"</span></h5><div class="tsd-comment tsd-typography"><h2 id="column-1" class="tsd-anchor-link">Column<a href="#column-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Specifies that the horizontal positioning shall be relative to the extents of the column which contains its anchor.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="inside_margin"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">INSIDE_MARGIN</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"insideMargin"</span></h5><div class="tsd-comment tsd-typography"><h2 id="inside-margin" class="tsd-anchor-link">Inside Margin<a href="#inside-margin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Specifies that the horizontal positioning shall be relative to the inside margin of the current page (the left margin on odd pages, right on even pages).</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="left_margin"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">LEFT_MARGIN</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"leftMargin"</span></h5><div class="tsd-comment tsd-typography"><h2 id="left-margin" class="tsd-anchor-link">Left Margin<a href="#left-margin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Specifies that the horizontal positioning shall be relative to the left margin of the page.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="margin"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">MARGIN</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"margin"</span></h5><div class="tsd-comment tsd-typography"><h2 id="page-margin" class="tsd-anchor-link">Page Margin<a href="#page-margin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Specifies that the horizontal positioning shall be relative to the page margins.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="outside_margin"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OUTSIDE_MARGIN</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"outsideMargin"</span></h5><div class="tsd-comment tsd-typography"><h2 id="outside-margin" class="tsd-anchor-link">Outside Margin<a href="#outside-margin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Specifies that the horizontal positioning shall be relative to the outside margin of the current page (the right margin on odd pages, left on even pages).</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="page"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">PAGE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"page"</span></h5><div class="tsd-comment tsd-typography"><h2 id="page-edge" class="tsd-anchor-link">Page Edge<a href="#page-edge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Specifies that the horizontal positioning shall be relative to the edge of the page.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="right_margin"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">RIGHT_MARGIN</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"rightMargin"</span></h5><div class="tsd-comment tsd-typography"><h2 id="right-margin" class="tsd-anchor-link">Right Margin<a href="#right-margin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Specifies that the horizontal positioning shall be relative to the right margin of the page.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a241a51cfdec5f37ce10b5a92e6934921d476747/src/file/drawing/floating/floating-position.ts#L12">file/drawing/floating/floating-position.ts:12</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#character-1"><span>Character</span></a><a href="#column-1"><span>Column</span></a><a href="#inside-margin"><span>Inside <wbr/>Margin</span></a><a href="#left-margin"><span>Left <wbr/>Margin</span></a><a href="#page-margin"><span>Page <wbr/>Margin</span></a><a href="#outside-margin"><span>Outside <wbr/>Margin</span></a><a href="#page-edge"><span>Page <wbr/>Edge</span></a><a href="#right-margin"><span>Right <wbr/>Margin</span></a></div></details></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>
|