smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ dolanmiu/docx@c3080ff9d9 🚀

Browse Source
This commit is contained in:
dolanmiu
2023-12-25 02:48:48 +00:00
parent b88b99f159
commit c4f13c5218
371 changed files with 3626 additions and 2931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
api/interfaces/IAlignmentFrameOptions.html
View File

@ -22,7 +22,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">IAlignmentFrameOptions</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/paragraph/frame/frame-properties.ts#L53">file/paragraph/frame/frame-properties.ts:53</a></li></ul></aside>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/paragraph/frame/frame-properties.ts#L53">file/paragraph/frame/frame-properties.ts:53</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@ -54,7 +54,7 @@
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">y</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;bottom&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;center&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;top&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;inside&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;outside&quot;</span></h5></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/paragraph/frame/frame-properties.ts#L54">file/paragraph/frame/frame-properties.ts:54</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/paragraph/frame/frame-properties.ts#L54">file/paragraph/frame/frame-properties.ts:54</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="anchor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>anchor</span><a href="#anchor" 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">anchor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">horizontal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;text&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;margin&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;page&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">vertical</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;text&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;margin&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;page&quot;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@ -67,37 +67,37 @@
<h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">vertical</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;text&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;margin&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;page&quot;</span></h5></li></ul></div><aside class="tsd-sources">
<p>Inherited from IBaseFrameOptions.anchor</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/paragraph/frame/frame-properties.ts#L35">file/paragraph/frame/frame-properties.ts:35</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/paragraph/frame/frame-properties.ts#L35">file/paragraph/frame/frame-properties.ts:35</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="anchorLock" 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>anchor<wbr/>Lock</span><a href="#anchorLock" 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">anchor<wbr/>Lock</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<p>Inherited from IBaseFrameOptions.anchorLock</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/paragraph/frame/frame-properties.ts#L29">file/paragraph/frame/frame-properties.ts:29</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/paragraph/frame/frame-properties.ts#L29">file/paragraph/frame/frame-properties.ts:29</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="dropCap" 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>drop<wbr/>Cap</span><a href="#dropCap" 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">drop<wbr/>Cap</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;none&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;margin&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;drop&quot;</span></div><aside class="tsd-sources">
<p>Inherited from IBaseFrameOptions.dropCap</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/paragraph/frame/frame-properties.ts#L30">file/paragraph/frame/frame-properties.ts:30</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/paragraph/frame/frame-properties.ts#L30">file/paragraph/frame/frame-properties.ts:30</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="height" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>height</span><a href="#height" 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">height</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<p>Inherited from IBaseFrameOptions.height</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/paragraph/frame/frame-properties.ts#L32">file/paragraph/frame/frame-properties.ts:32</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/paragraph/frame/frame-properties.ts#L32">file/paragraph/frame/frame-properties.ts:32</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="lines" 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>lines</span><a href="#lines" 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">lines</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<p>Inherited from IBaseFrameOptions.lines</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/paragraph/frame/frame-properties.ts#L34">file/paragraph/frame/frame-properties.ts:34</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/paragraph/frame/frame-properties.ts#L34">file/paragraph/frame/frame-properties.ts:34</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="rule" 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>rule</span><a href="#rule" 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">rule</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;auto&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;atLeast&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;exact&quot;</span></div><aside class="tsd-sources">
<p>Inherited from IBaseFrameOptions.rule</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/paragraph/frame/frame-properties.ts#L43">file/paragraph/frame/frame-properties.ts:43</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/paragraph/frame/frame-properties.ts#L43">file/paragraph/frame/frame-properties.ts:43</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="space" 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>space</span><a href="#space" 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">space</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">horizontal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">vertical</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@ -110,19 +110,19 @@
<h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">vertical</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div><aside class="tsd-sources">
<p>Inherited from IBaseFrameOptions.space</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/paragraph/frame/frame-properties.ts#L39">file/paragraph/frame/frame-properties.ts:39</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/paragraph/frame/frame-properties.ts#L39">file/paragraph/frame/frame-properties.ts:39</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="width" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>width</span><a href="#width" 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">width</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<p>Inherited from IBaseFrameOptions.width</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/paragraph/frame/frame-properties.ts#L31">file/paragraph/frame/frame-properties.ts:31</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/paragraph/frame/frame-properties.ts#L31">file/paragraph/frame/frame-properties.ts:31</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="wrap" 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>wrap</span><a href="#wrap" 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">wrap</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;auto&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;none&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;around&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;notBeside&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;through&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;tight&quot;</span></div><aside class="tsd-sources">
<p>Inherited from IBaseFrameOptions.wrap</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/paragraph/frame/frame-properties.ts#L33">file/paragraph/frame/frame-properties.ts:33</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/paragraph/frame/frame-properties.ts#L33">file/paragraph/frame/frame-properties.ts:33</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@ -227,7 +227,6 @@
<li><a href="../classes/LevelBase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Level<wbr/>Base</span></a></li>
<li><a href="../classes/LevelForOverride.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Level<wbr/>For<wbr/>Override</span></a></li>
<li><a href="../classes/LevelOverride.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Level<wbr/>Override</span></a></li>
<li><a href="../classes/LineNumberType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Line<wbr/>Number<wbr/>Type</span></a></li>
<li><a href="../classes/Math.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Math</span></a></li>
<li><a href="../classes/MathAccentCharacter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Math<wbr/>Accent<wbr/>Character</span></a></li>
<li><a href="../classes/MathAngledBrackets.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Math<wbr/>Angled<wbr/>Brackets</span></a></li>
@ -373,7 +372,6 @@
<li><a href="IIndentAttributesProperties.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IIndent<wbr/>Attributes<wbr/>Properties</span></a></li>
<li><a href="ILevelParagraphStylePropertiesOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ILevel<wbr/>Paragraph<wbr/>Style<wbr/>Properties<wbr/>Options</span></a></li>
<li><a href="ILevelsOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ILevels<wbr/>Options</span></a></li>
<li><a href="ILineNumberAttributes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ILine<wbr/>Number<wbr/>Attributes</span></a></li>
<li><a href="IMargins.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IMargins</span></a></li>
<li><a href="IMathFractionOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IMath<wbr/>Fraction<wbr/>Options</span></a></li>
<li><a href="IMathFunctionOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IMath<wbr/>Function<wbr/>Options</span></a></li>
@ -427,7 +425,9 @@
<li><a href="../types/AttributePayload.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Attribute<wbr/>Payload</span></a></li>
<li><a href="../types/IColumnsAttributes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IColumns<wbr/>Attributes</span></a></li>
<li><a href="../types/IFrameOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IFrame<wbr/>Options</span></a></li>
<li><a href="../types/ILineNumberAttributes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>ILine<wbr/>Number<wbr/>Attributes</span></a></li>
<li><a href="../types/IPageMarginAttributes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IPage<wbr/>Margin<wbr/>Attributes</span></a></li>
<li><a href="../types/IPageReferenceOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IPage<wbr/>Reference<wbr/>Options</span></a></li>
<li><a href="../types/IPageSizeAttributes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IPage<wbr/>Size<wbr/>Attributes</span></a></li>
<li><a href="../types/IPatch.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IPatch</span></a></li>
<li><a href="../types/ITableFloatOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>ITable<wbr/>Float<wbr/>Options</span></a></li>
@ -499,6 +499,7 @@
<li><a href="../functions/convertInchesToTwip.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>Inches<wbr/>To<wbr/>Twip</span></a></li>
<li><a href="../functions/convertMillimetersToTwip.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>Millimeters<wbr/>To<wbr/>Twip</span></a></li>
<li><a href="../functions/convertToXmlComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>To<wbr/>Xml<wbr/>Component</span></a></li>
<li><a href="../functions/createLineNumberType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Line<wbr/>Number<wbr/>Type</span></a></li>
<li><a href="../functions/dateTimeValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>date<wbr/>Time<wbr/>Value</span></a></li>
<li><a href="../functions/decimalNumber.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>decimal<wbr/>Number</span></a></li>
<li><a href="../functions/docPropertiesUniqueNumericIdGen.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>doc<wbr/>Properties<wbr/>Unique<wbr/>Numeric<wbr/>Id<wbr/>Gen</span></a></li>