smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
4efe7793211b75f218b1faac207e166a0b890689
docx-js/api/types/ILevelParagraphStylePropertiesOptions.html

14 lines
21 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ dolanmiu/docx@b1bb95df79dc358076e91ab68a85af7b549f54f1 🚀
2025-04-22 21:18:53 +00:00
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ILevelParagraphStylePropertiesOptions | 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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">docx</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">ILevelParagraphStylePropertiesOptions</a></li></ul><h1>Type Alias ILevelParagraphStylePropertiesOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">ILevelParagraphStylePropertiesOptions</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#alignment">alignment</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/AlignmentType.html" class="tsd-signature-type tsd-kind-variable">AlignmentType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/AlignmentType.html" class="tsd-signature-type tsd-kind-variable">AlignmentType</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#contextualspacing">contextualSpacing</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#indent">indent</a><span class="tsd-signature-symbol">?:</span> <a href="IIndentAttributesProperties.html" class="tsd-signature-type tsd-kind-type-alias">IIndentAttributesProperties</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#keeplines">keepLines</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#keepnext">keepNext</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-si
Deploying to gh-pages from @ dolanmiu/docx@4e0468d9784b9386fd2769f67bdfbaeec28add5b 🚀
2025-04-16 07:59:44 +00:00
<a href="#contextualspacing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>contextual<wbr/>Spacing?</span></a>
<a href="#indent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>indent?</span></a>
<a href="#keeplines" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>keep<wbr/>Lines?</span></a>
<a href="#keepnext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>keep<wbr/>Next?</span></a>
<a href="#lefttabstop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>left<wbr/>Tab<wbr/>Stop?</span></a>
<a href="#outlinelevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outline<wbr/>Level?</span></a>
<a href="#righttabstop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>right<wbr/>Tab<wbr/>Stop?</span></a>
<a href="#spacing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spacing?</span></a>
<a href="#thematicbreak" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>thematic<wbr/>Break?</span></a>
Deploying to gh-pages from @ dolanmiu/docx@b1bb95df79dc358076e91ab68a85af7b549f54f1 🚀
2025-04-22 21:18:53 +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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="alignment"><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" aria-hidden="true"><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> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/AlignmentType.html" class="tsd-signature-type tsd-kind-variable">AlignmentType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/AlignmentType.html" class="tsd-signature-type tsd-kind-variable">AlignmentType</a><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/paragraph/properties.ts#L22">file/paragraph/properties.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="contextualspacing"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">contextualSpacing</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/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/paragraph/properties.ts#L24">file/paragraph/properties.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="indent"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>indent</span><a href="#indent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">indent</span><span class="tsd-signature-symbol">?:</span> <a href="IIndentAttributesProperties.html" class="tsd-signature-type tsd-kind-type-alias">IIndentAttributesProperties</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/paragraph/properties.ts#L27">file/paragraph/properties.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="keeplines"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>keep<wbr/>Lines</span><a href="#keeplines" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">keepLines</span><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/paragraph/properties.ts#L36">file/paragraph/properties.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="keepnext"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">keepNext</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"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/paragraph/properties.ts#L32">file/paragraph/properties.ts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="lefttabstop"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">leftTabStop</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/paragraph/properties.ts#L26">file/paragraph/properties.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="outlinelevel"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">outlineLevel</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/paragraph/properties.ts#L37">file/paragraph/properties.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="righttabstop"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>right<wbr/>Tab<wbr/>Stop</span><a href="#righttabstop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">rightTabStop</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/paragraph/properties.ts#L25">file/paragraph/properties.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="spacing"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>spacing</span><a href="#spacing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">spacing</span><span class="tsd-signature-symbol">?:</span> <a href="ISpacingProperties.html" class="tsd-signature-type tsd-kind-type-alias">ISpacingProperties</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/paragraph/properties.ts#L28">file/paragraph/properties.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="thematicbreak"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>thematic<wbr/>Break</span><a href="#thematicbreak" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">thematicBreak</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/b1bb95
Reference in New Issue Copy Permalink