smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
dbd8eb556b092a699898f82764a5aeec2ee72c90
docx-js/api/interfaces/IParagraphStylePropertiesOptions.html

15 lines
30 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ dolanmiu/docx@5f4ff94e261d740de81fa8f3fa11ff2d08a0eeba 🚀
2024-10-19 03:19:24 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IParagraphStylePropertiesOptions | 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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</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="../assets/icons.svg#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="../assets/icons.svg#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="IParagraphStylePropertiesOptions.html">IParagraphStylePropertiesOptions</a></li></ul><h1>Interface IParagraphStylePropertiesOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IParagraphStylePropertiesOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="IParagraphStylePropertiesOptions.html#alignment">alignment</a><span class="tsd-signature-symbol">?: </span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;center&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;left&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;right&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;start&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;end&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;both&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;mediumKashida&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;distribute&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;numTab&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;highKashida&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;lowKashida&quot;</span><br/><span>        </
Deploying to gh-pages from @ dolanmiu/docx@c198154fdc2ac21768afe139c717a457b04f2e5a 🚀
2024-10-09 20:29:20 +00:00
<a href="IParagraphStylePropertiesOptions.html#contextualSpacing" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>contextual<wbr/>Spacing?</span></a>
<a href="IParagraphStylePropertiesOptions.html#indent" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>indent?</span></a>
<a href="IParagraphStylePropertiesOptions.html#keepLines" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>keep<wbr/>Lines?</span></a>
<a href="IParagraphStylePropertiesOptions.html#keepNext" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>keep<wbr/>Next?</span></a>
<a href="IParagraphStylePropertiesOptions.html#leftTabStop" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>left<wbr/>Tab<wbr/>Stop?</span></a>
<a href="IParagraphStylePropertiesOptions.html#numbering" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>numbering?</span></a>
<a href="IParagraphStylePropertiesOptions.html#outlineLevel" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outline<wbr/>Level?</span></a>
<a href="IParagraphStylePropertiesOptions.html#rightTabStop" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>right<wbr/>Tab<wbr/>Stop?</span></a>
<a href="IParagraphStylePropertiesOptions.html#spacing" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spacing?</span></a>
<a href="IParagraphStylePropertiesOptions.html#thematicBreak" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>thematic<wbr/>Break?</span></a>
Deploying to gh-pages from @ dolanmiu/docx@5f4ff94e261d740de81fa8f3fa11ff2d08a0eeba 🚀
2024-10-19 03:19:24 +00:00
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="alignment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>alignment</span><a href="#alignment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">alignment</span><span class="tsd-signature-symbol">?:</span> <br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;center&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;left&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;right&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;start&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;end&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;both&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;mediumKashida&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;distribute&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;numTab&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;highKashida&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;lowKashida&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;thaiDistribute&quot;</span></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/5f4ff94e261d740de81fa8f3fa11ff2d08a0eeba/src/file/paragraph/properties.ts#L21">file/paragraph/properties.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="contextualSpacing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>contextual<wbr/>Spacing</span><a href="#contextualSpacing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">contextual<wbr/>Spacing</span><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/5f4ff94e261d740de81fa8f3fa11ff2d08a0eeba/src/file/paragraph/properties.ts#L23">file/paragraph/properties.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="indent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>indent</span><a
</div><div class="tsd-comment tsd-typography"></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/5f4ff94e261d740de81fa8f3fa11ff2d08a0eeba/src/file/paragraph/properties.ts#L35">file/paragraph/properties.ts:35</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="keepNext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>keep<wbr/>Next</span><a href="#keepNext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">keep<wbr/>Next</span><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><div class="tsd-comment tsd-typography"></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/5f4ff94e261d740de81fa8f3fa11ff2d08a0eeba/src/file/paragraph/properties.ts#L31">file/paragraph/properties.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="leftTabStop" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>left<wbr/>Tab<wbr/>Stop</span><a href="#leftTabStop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">left<wbr/>Tab<wbr/>Stop</span><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/5f4ff94e261d740de81fa8f3fa11ff2d08a0eeba/src/file/paragraph/properties.ts#L25">file/paragraph/properties.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="numbering" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>numbering</span><a href="#numbering" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">numbering</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">custom</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">instance</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">level</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">reference</span><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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/5f4ff94e261d740de81fa8f3fa11ff2d08a0eeba/src/file/paragraph/properties.ts#L40">file/paragraph/properties.ts:40</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="outlineLevel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>outline<wbr/>Level</span><a href="#outlineLevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">outline<wbr/>Level</span><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/5f4
Reference in New Issue Copy Permalink