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

Deploying to gh-pages from @ dolanmiu/docx@91379070d3 🚀

Browse Source
This commit is contained in:
dolanmiu
2023-06-12 19:08:34 +00:00
parent 284b5c4c1f
commit 40f73e0ad8
371 changed files with 4520 additions and 2092 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
api/interfaces/IParagraphStylePropertiesOptions.html
View File

@ -24,7 +24,7 @@
<ul class="tsd-hierarchy">
<li><a href="IParagraphPropertiesOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IParagraphPropertiesOptions</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33332bc/src/file/paragraph/properties.ts#L31">src/file/paragraph/properties.ts:31</a></li></ul></aside>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9137907/src/file/paragraph/properties.ts#L37">src/file/paragraph/properties.ts:37</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">
@ -51,37 +51,41 @@
<div class="tsd-signature">alignment<span class="tsd-signature-symbol">?:</span> <a href="../enums/AlignmentType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AlignmentType</a></div><aside class="tsd-sources">
<p>Inherited from <a href="ILevelParagraphStylePropertiesOptions.html">ILevelParagraphStylePropertiesOptions</a>.<a href="ILevelParagraphStylePropertiesOptions.html#alignment">alignment</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33332bc/src/file/paragraph/properties.ts#L19">src/file/paragraph/properties.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9137907/src/file/paragraph/properties.ts#L19">src/file/paragraph/properties.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="contextualSpacing" 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>contextual<wbr/>Spacing</span><a href="#contextualSpacing" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">contextual<wbr/>Spacing<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<p>Inherited from <a href="ILevelParagraphStylePropertiesOptions.html">ILevelParagraphStylePropertiesOptions</a>.<a href="ILevelParagraphStylePropertiesOptions.html#contextualSpacing">contextualSpacing</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33332bc/src/file/paragraph/properties.ts#L21">src/file/paragraph/properties.ts:21</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9137907/src/file/paragraph/properties.ts#L21">src/file/paragraph/properties.ts:21</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="indent" 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>indent</span><a href="#indent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">indent<span class="tsd-signature-symbol">?:</span> <a href="IIndentAttributesProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">IIndentAttributesProperties</a></div><aside class="tsd-sources">
<p>Inherited from <a href="ILevelParagraphStylePropertiesOptions.html">ILevelParagraphStylePropertiesOptions</a>.<a href="ILevelParagraphStylePropertiesOptions.html#indent">indent</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33332bc/src/file/paragraph/properties.ts#L24">src/file/paragraph/properties.ts:24</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9137907/src/file/paragraph/properties.ts#L24">src/file/paragraph/properties.ts:24</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="keepLines" 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>keep<wbr/>Lines</span><a href="#keepLines" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">keep<wbr/>Lines<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<div class="tsd-signature">keep<wbr/>Lines<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
<div class="tsd-comment tsd-typography"><p>Specifies that all lines of the paragraph are to be kept on a single page when possible.</p>
</div><aside class="tsd-sources">
<p>Inherited from <a href="ILevelParagraphStylePropertiesOptions.html">ILevelParagraphStylePropertiesOptions</a>.<a href="ILevelParagraphStylePropertiesOptions.html#keepLines">keepLines</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33332bc/src/file/paragraph/properties.ts#L27">src/file/paragraph/properties.ts:27</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9137907/src/file/paragraph/properties.ts#L33">src/file/paragraph/properties.ts:33</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="keepNext" 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>keep<wbr/>Next</span><a href="#keepNext" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">keep<wbr/>Next<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<div class="tsd-signature">keep<wbr/>Next<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
<div class="tsd-comment tsd-typography"><p>Specifies that the paragraph (or at least part of it) should be rendered on the same page as the next paragraph when possible. If multiple paragraphs are to be kept together but they exceed a page, then the set of paragraphs begin on a new page and page breaks are used thereafter as needed.</p>
</div><aside class="tsd-sources">
<p>Inherited from <a href="ILevelParagraphStylePropertiesOptions.html">ILevelParagraphStylePropertiesOptions</a>.<a href="ILevelParagraphStylePropertiesOptions.html#keepNext">keepNext</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33332bc/src/file/paragraph/properties.ts#L26">src/file/paragraph/properties.ts:26</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9137907/src/file/paragraph/properties.ts#L29">src/file/paragraph/properties.ts:29</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="leftTabStop" 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>left<wbr/>Tab<wbr/>Stop</span><a href="#leftTabStop" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">left<wbr/>Tab<wbr/>Stop<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<p>Inherited from <a href="ILevelParagraphStylePropertiesOptions.html">ILevelParagraphStylePropertiesOptions</a>.<a href="ILevelParagraphStylePropertiesOptions.html#leftTabStop">leftTabStop</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33332bc/src/file/paragraph/properties.ts#L23">src/file/paragraph/properties.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9137907/src/file/paragraph/properties.ts#L23">src/file/paragraph/properties.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="numbering" 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>numbering</span><a href="#numbering" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">numbering<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>custom<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>instance<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>reference<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@ -97,31 +101,31 @@
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagReadonly">Readonly</code> reference<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33332bc/src/file/paragraph/properties.ts#L32">src/file/paragraph/properties.ts:32</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9137907/src/file/paragraph/properties.ts#L38">src/file/paragraph/properties.ts:38</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outlineLevel" 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>outline<wbr/>Level</span><a href="#outlineLevel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">outline<wbr/>Level<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<p>Inherited from <a href="ILevelParagraphStylePropertiesOptions.html">ILevelParagraphStylePropertiesOptions</a>.<a href="ILevelParagraphStylePropertiesOptions.html#outlineLevel">outlineLevel</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33332bc/src/file/paragraph/properties.ts#L28">src/file/paragraph/properties.ts:28</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9137907/src/file/paragraph/properties.ts#L34">src/file/paragraph/properties.ts:34</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="rightTabStop" 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>right<wbr/>Tab<wbr/>Stop</span><a href="#rightTabStop" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">right<wbr/>Tab<wbr/>Stop<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<p>Inherited from <a href="ILevelParagraphStylePropertiesOptions.html">ILevelParagraphStylePropertiesOptions</a>.<a href="ILevelParagraphStylePropertiesOptions.html#rightTabStop">rightTabStop</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33332bc/src/file/paragraph/properties.ts#L22">src/file/paragraph/properties.ts:22</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9137907/src/file/paragraph/properties.ts#L22">src/file/paragraph/properties.ts:22</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="spacing" 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>spacing</span><a href="#spacing" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">spacing<span class="tsd-signature-symbol">?:</span> <a href="ISpacingProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">ISpacingProperties</a></div><aside class="tsd-sources">
<p>Inherited from <a href="ILevelParagraphStylePropertiesOptions.html">ILevelParagraphStylePropertiesOptions</a>.<a href="ILevelParagraphStylePropertiesOptions.html#spacing">spacing</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33332bc/src/file/paragraph/properties.ts#L25">src/file/paragraph/properties.ts:25</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9137907/src/file/paragraph/properties.ts#L25">src/file/paragraph/properties.ts:25</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="thematicBreak" 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>thematic<wbr/>Break</span><a href="#thematicBreak" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">thematic<wbr/>Break<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<p>Inherited from <a href="ILevelParagraphStylePropertiesOptions.html">ILevelParagraphStylePropertiesOptions</a>.<a href="ILevelParagraphStylePropertiesOptions.html#thematicBreak">thematicBreak</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33332bc/src/file/paragraph/properties.ts#L20">src/file/paragraph/properties.ts:20</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9137907/src/file/paragraph/properties.ts#L20">src/file/paragraph/properties.ts:20</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">