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/ISectionPropertiesOptions.html
View File

@ -20,7 +20,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">ISectionPropertiesOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/document/body/section-properties/section-properties.ts#L26">file/document/body/section-properties/section-properties.ts:26</a></li></ul></aside>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/document/body/section-properties/section-properties.ts#L26">file/document/body/section-properties/section-properties.ts:26</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">
@ -44,27 +44,27 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>column</span><a href="#column" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">column</span><span class="tsd-signature-symbol">?:</span> <a href="../types/IColumnsAttributes.html" class="tsd-signature-type tsd-kind-type-alias">IColumnsAttributes</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/document/body/section-properties/section-properties.ts#L40">file/document/body/section-properties/section-properties.ts:40</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/document/body/section-properties/section-properties.ts#L40">file/document/body/section-properties/section-properties.ts:40</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="footerWrapperGroup" 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>footer<wbr/>Wrapper<wbr/>Group</span><a href="#footerWrapperGroup" 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">footer<wbr/>Wrapper<wbr/>Group</span><span class="tsd-signature-symbol">?:</span> <a href="IHeaderFooterGroup.html" class="tsd-signature-type tsd-kind-interface">IHeaderFooterGroup</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/FooterWrapper.html" class="tsd-signature-type tsd-kind-class">FooterWrapper</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/document/body/section-properties/section-properties.ts#L36">file/document/body/section-properties/section-properties.ts:36</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/document/body/section-properties/section-properties.ts#L36">file/document/body/section-properties/section-properties.ts:36</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="grid" 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>grid</span><a href="#grid" 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">grid</span><span class="tsd-signature-symbol">?:</span> <a href="IDocGridAttributesProperties.html" class="tsd-signature-type tsd-kind-interface">IDocGridAttributesProperties</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/document/body/section-properties/section-properties.ts#L34">file/document/body/section-properties/section-properties.ts:34</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/document/body/section-properties/section-properties.ts#L34">file/document/body/section-properties/section-properties.ts:34</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="headerWrapperGroup" 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>header<wbr/>Wrapper<wbr/>Group</span><a href="#headerWrapperGroup" 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">header<wbr/>Wrapper<wbr/>Group</span><span class="tsd-signature-symbol">?:</span> <a href="IHeaderFooterGroup.html" class="tsd-signature-type tsd-kind-interface">IHeaderFooterGroup</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/HeaderWrapper.html" class="tsd-signature-type tsd-kind-class">HeaderWrapper</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/document/body/section-properties/section-properties.ts#L35">file/document/body/section-properties/section-properties.ts:35</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/document/body/section-properties/section-properties.ts#L35">file/document/body/section-properties/section-properties.ts:35</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="lineNumbers" 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>line<wbr/>Numbers</span><a href="#lineNumbers" 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">line<wbr/>Numbers</span><span class="tsd-signature-symbol">?:</span> <a href="ILineNumberAttributes.html" class="tsd-signature-type tsd-kind-interface">ILineNumberAttributes</a></div><aside class="tsd-sources">
<div class="tsd-signature"><span class="tsd-kind-property">line<wbr/>Numbers</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ILineNumberAttributes.html" class="tsd-signature-type tsd-kind-type-alias">ILineNumberAttributes</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/document/body/section-properties/section-properties.ts#L37">file/document/body/section-properties/section-properties.ts:37</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/document/body/section-properties/section-properties.ts#L37">file/document/body/section-properties/section-properties.ts:37</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="page" 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>page</span><a href="#page" 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">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">borders</span><span class="tsd-signature-symbol">?: </span><a href="IPageBordersOptions.html" class="tsd-signature-type tsd-kind-interface">IPageBordersOptions</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">margin</span><span class="tsd-signature-symbol">?: </span><a href="../types/IPageMarginAttributes.html" class="tsd-signature-type tsd-kind-type-alias">IPageMarginAttributes</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">pageNumbers</span><span class="tsd-signature-symbol">?: </span><a href="IPageNumberTypeAttributes.html" class="tsd-signature-type tsd-kind-interface">IPageNumberTypeAttributes</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">size</span><span class="tsd-signature-symbol">?: </span><a href="../types/IPageSizeAttributes.html" class="tsd-signature-type tsd-kind-type-alias">IPageSizeAttributes</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">textDirection</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;lrTb&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;tbRl&quot;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@ -82,22 +82,22 @@
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">text<wbr/>Direction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;lrTb&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;tbRl&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/document/body/section-properties/section-properties.ts#L27">file/document/body/section-properties/section-properties.ts:27</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/document/body/section-properties/section-properties.ts#L27">file/document/body/section-properties/section-properties.ts:27</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="titlePage" 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>title<wbr/>Page</span><a href="#titlePage" 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">title<wbr/>Page</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/772fc84/src/file/document/body/section-properties/section-properties.ts#L38">file/document/body/section-properties/section-properties.ts:38</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/document/body/section-properties/section-properties.ts#L38">file/document/body/section-properties/section-properties.ts:38</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="type" 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>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;continuous&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;nextPage&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;nextColumn&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;evenPage&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;oddPage&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/document/body/section-properties/section-properties.ts#L41">file/document/body/section-properties/section-properties.ts:41</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/document/body/section-properties/section-properties.ts#L41">file/document/body/section-properties/section-properties.ts:41</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="verticalAlign" 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>vertical<wbr/>Align</span><a href="#verticalAlign" 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">vertical<wbr/>Align</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></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/document/body/section-properties/section-properties.ts#L39">file/document/body/section-properties/section-properties.ts:39</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/document/body/section-properties/section-properties.ts#L39">file/document/body/section-properties/section-properties.ts:39</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@ -201,7 +201,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>
@ -347,7 +346,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>
@ -401,7 +399,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>
@ -473,6 +473,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>