Files
docx-js/api/interfaces/IFloating.html

10 lines
34 KiB
HTML
Raw Normal View History

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IFloating | 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/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><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="#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="#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="IFloating.html">IFloating</a></li></ul><h1>Interface IFloating</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IFloating</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="IFloating.html#allowOverlap">allowOverlap</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="IFloating.html#behindDocument">behindDocument</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="IFloating.html#horizontalPosition">horizontalPosition</a><span class="tsd-signature-symbol">: </span><a href="IHorizontalPositionOptions.html" class="tsd-signature-type tsd-kind-interface">IHorizontalPositionOptions</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="IFloating.html#layoutInCell">layoutInCell</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="IFloating.html#lockAnchor">lockAnchor</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="IFloating.html#margins">margins</a><span class="tsd-signature-symbol">?: </span><a href="IMargins.html" class="tsd-signature-type tsd-kind-interface">IMargins</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="IFloating.html#verticalPosition">verticalPosition</a><span class="tsd-signature-symbol">: </span><a href="IVerticalPositionOptions.html" class="tsd-signature-type tsd-kind-interface">IVerticalPositionOptions</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="IFloating.html#wrap">wrap</a><span class="tsd-signature-symbol">?: </span><a href="ITextWrapping.html" class="tsd
<a href="IFloating.html#behindDocument" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>behind<wbr/>Document?</span></a>
<a href="IFloating.html#horizontalPosition" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>horizontal<wbr/>Position</span></a>
<a href="IFloating.html#layoutInCell" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>layout<wbr/>In<wbr/>Cell?</span></a>
<a href="IFloating.html#lockAnchor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lock<wbr/>Anchor?</span></a>
<a href="IFloating.html#margins" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>margins?</span></a>
<a href="IFloating.html#verticalPosition" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>vertical<wbr/>Position</span></a>
<a href="IFloating.html#wrap" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>wrap?</span></a>
<a href="IFloating.html#zIndex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>z<wbr/>Index?</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="allowOverlap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>allow<wbr/>Overlap</span><a href="#allowOverlap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">allow<wbr/>Overlap</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/618c7a8/src/file/drawing/floating/floating-position.ts#L53">file/drawing/floating/floating-position.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="behindDocument" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>behind<wbr/>Document</span><a href="#behindDocument" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">behind<wbr/>Document</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/618c7a8/src/file/drawing/floating/floating-position.ts#L55">file/drawing/floating/floating-position.ts:55</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="horizontalPosition" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>horizontal<wbr/>Position</span><a href="#horizontalPosition" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">horizontal<wbr/>Position</span><span class="tsd-signature-symbol">:</span> <a href="IHorizontalPositionOptions.html" class="tsd-signature-type tsd-kind-interface">IHorizontalPositionOptions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/618c7a8/src/file/drawing/floating/floating-position.ts#L51">file/drawing/floating/floating-position.ts:51</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="layoutInCell" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>layout<wbr/>In<wbr/>Cell</span><a href="#layoutInCell" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">layout<wbr/>In<wbr/>Cell</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/618c7a8/src/file/drawing/floating/floating-position.ts#L56">file/drawing/floating/floating-position.ts:56</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="lockAnchor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>lock<wbr/>Anchor</span><a href="#lockAnchor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">lock<wbr/>Anchor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/618c7a8/src/file/drawing/floating/floating-p