35 lines
61 KiB
HTML
35 lines
61 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IParagraphOptions | 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="IParagraphOptions.html">IParagraphOptions</a></li></ul><h1>Interface IParagraphOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IParagraphOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#alignment">alignment</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"center"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"left"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"right"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"start"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"end"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"both"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mediumKashida"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"distribute"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"numTab"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"highKashida"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"lowKashida"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thaiDistribute"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#autoSpaceEastAsianText">autoSpaceEastAsianText</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#bidirectional">bidirectional</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#border">border</a><span class="tsd-signature-symbol">?: </span><a href="IBordersOptions.html" class="tsd-signature-type tsd-kind-interface">IBordersOptions</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#bullet">bullet</a><span class="tsd-signature-symbol">?: </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-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#children">children</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-keyword">readonly </span><a href="../types/ParagraphChild.html" class="tsd-signature-type tsd-kind-type-alias">ParagraphChild</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#contextualSpacing">contextualSpacing</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#frame">frame</a><span class="tsd-signature-symbol">?: </span><a href="../types/IFrameOptions.html" class="tsd-signature-type tsd-kind-type-alias">IFrameOptions</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#heading">heading</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"Heading1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Heading2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Heading3"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Heading4"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Heading5"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Heading6"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Title"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#indent">indent</a><span class="tsd-signature-symbol">?: </span><a href="IIndentAttributesProperties.html" class="tsd-signature-type tsd-kind-interface">IIndentAttributesProperties</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#keepLines">keepLines</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#keepNext">keepNext</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#leftTabStop">leftTabStop</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#numbering">numbering</a><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> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#outlineLevel">outlineLevel</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#overflowPunctuation">overflowPunctuation</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#pageBreakBefore">pageBreakBefore</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#rightTabStop">rightTabStop</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#run">run</a><span class="tsd-signature-symbol">?: </span><a href="IRunOptions.html" class="tsd-signature-type tsd-kind-interface">IRunOptions</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#scale">scale</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#shading">shading</a><span class="tsd-signature-symbol">?: </span><a href="IShadingAttributesProperties.html" class="tsd-signature-type tsd-kind-interface">IShadingAttributesProperties</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#spacing">spacing</a><span class="tsd-signature-symbol">?: </span><a href="ISpacingProperties.html" class="tsd-signature-type tsd-kind-interface">ISpacingProperties</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#style">style</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#suppressLineNumbers">suppressLineNumbers</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#tabStops">tabStops</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-keyword">readonly </span><a href="TabStopDefinition.html" class="tsd-signature-type tsd-kind-interface">TabStopDefinition</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#text">text</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#thematicBreak">thematicBreak</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#widowControl">widowControl</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IParagraphOptions.html#wordWrap">wordWrap</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#IParagraphOptions">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="IParagraphPropertiesOptions.html" class="tsd-signature-type tsd-kind-interface">IParagraphPropertiesOptions</a><ul class="tsd-hierarchy"><li><span class="target">IParagraphOptions</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/paragraph.ts#L40">file/paragraph/paragraph.ts:40</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"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="IParagraphOptions.html#alignment" 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>alignment?</span></a>
|
||
<a href="IParagraphOptions.html#autoSpaceEastAsianText" 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>auto<wbr/>Space<wbr/>East<wbr/>Asian<wbr/>Text?</span></a>
|
||
<a href="IParagraphOptions.html#bidirectional" 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>bidirectional?</span></a>
|
||
<a href="IParagraphOptions.html#border" 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>border?</span></a>
|
||
<a href="IParagraphOptions.html#bullet" 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>bullet?</span></a>
|
||
<a href="IParagraphOptions.html#children" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>children?</span></a>
|
||
<a href="IParagraphOptions.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="IParagraphOptions.html#frame" 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>frame?</span></a>
|
||
<a href="IParagraphOptions.html#heading" 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>heading?</span></a>
|
||
<a href="IParagraphOptions.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="IParagraphOptions.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="IParagraphOptions.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="IParagraphOptions.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="IParagraphOptions.html#numbering" 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>numbering?</span></a>
|
||
<a href="IParagraphOptions.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="IParagraphOptions.html#overflowPunctuation" 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>overflow<wbr/>Punctuation?</span></a>
|
||
<a href="IParagraphOptions.html#pageBreakBefore" 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>page<wbr/>Break<wbr/>Before?</span></a>
|
||
<a href="IParagraphOptions.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="IParagraphOptions.html#run" 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>run?</span></a>
|
||
<a href="IParagraphOptions.html#scale" 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>scale?</span></a>
|
||
<a href="IParagraphOptions.html#shading" 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>shading?</span></a>
|
||
<a href="IParagraphOptions.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="IParagraphOptions.html#style" 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>style?</span></a>
|
||
<a href="IParagraphOptions.html#suppressLineNumbers" 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>suppress<wbr/>Line<wbr/>Numbers?</span></a>
|
||
<a href="IParagraphOptions.html#tabStops" 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>tab<wbr/>Stops?</span></a>
|
||
<a href="IParagraphOptions.html#text" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text?</span></a>
|
||
<a href="IParagraphOptions.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>
|
||
<a href="IParagraphOptions.html#widowControl" 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>widow<wbr/>Control?</span></a>
|
||
<a href="IParagraphOptions.html#wordWrap" 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>word<wbr/>Wrap?</span></a>
|
||
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><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 ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">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> <span class="tsd-signature-type">"center"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"left"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"right"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"start"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"end"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"both"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mediumKashida"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"distribute"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"numTab"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"highKashida"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"lowKashida"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thaiDistribute"</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#alignment">alignment</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/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="autoSpaceEastAsianText" 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>auto<wbr/>Space<wbr/>East<wbr/>Asian<wbr/>Text</span><a href="#autoSpaceEastAsianText" 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">auto<wbr/>Space<wbr/>East<wbr/>Asian<wbr/>Text</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>This element specifies whether inter-character spacing shall automatically be adjusted between regions of numbers and regions of East Asian text in the current paragraph. These regions shall be determined by the Unicode character values of the text content within the paragraph.
|
||
This only works in Microsoft Word. It is not part of the ECMA-376 OOXML standard.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#autoSpaceEastAsianText">autoSpaceEastAsianText</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L71">file/paragraph/properties.ts:71</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="bidirectional" 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>bidirectional</span><a href="#bidirectional" 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">bidirectional</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#bidirectional">bidirectional</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L53">file/paragraph/properties.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="border" 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>border</span><a href="#border" 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">border</span><span class="tsd-signature-symbol">?:</span> <a href="IBordersOptions.html" class="tsd-signature-type tsd-kind-interface">IBordersOptions</a></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#border">border</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L51">file/paragraph/properties.ts:51</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="bullet" 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>bullet</span><a href="#bullet" 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">bullet</span><span class="tsd-signature-symbol">?:</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 class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">level</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 <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#bullet">bullet</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L57">file/paragraph/properties.ts:57</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="children" 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>children</span><a href="#children" 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">children</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly </span><a href="../types/ParagraphChild.html" class="tsd-signature-type tsd-kind-type-alias">ParagraphChild</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/paragraph.ts#L42">file/paragraph/paragraph.ts:42</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 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 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="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#contextualSpacing">contextualSpacing</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/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="frame" 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>frame</span><a href="#frame" 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">frame</span><span class="tsd-signature-symbol">?:</span> <a href="../types/IFrameOptions.html" class="tsd-signature-type tsd-kind-type-alias">IFrameOptions</a></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#frame">frame</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L62">file/paragraph/properties.ts:62</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="heading" 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>heading</span><a href="#heading" 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">heading</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"Heading1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Heading2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Heading3"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Heading4"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Heading5"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Heading6"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Title"</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#heading">heading</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L52">file/paragraph/properties.ts:52</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 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 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">indent</span><span class="tsd-signature-symbol">?:</span> <a href="IIndentAttributesProperties.html" class="tsd-signature-type tsd-kind-interface">IIndentAttributesProperties</a></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#indent">indent</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L26">file/paragraph/properties.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member 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 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/>Lines</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"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#keepLines">keepLines</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/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 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 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="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#keepNext">keepNext</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/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 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 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="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#leftTabStop">leftTabStop</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L25">file/paragraph/properties.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><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 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><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><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">custom</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><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">instance</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">level</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">reference</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#numbering">numbering</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/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 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 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="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#outlineLevel">outlineLevel</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L36">file/paragraph/properties.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="overflowPunctuation" 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>overflow<wbr/>Punctuation</span><a href="#overflowPunctuation" 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">overflow<wbr/>Punctuation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#overflowPunctuation">overflowPunctuation</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L65">file/paragraph/properties.ts:65</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="pageBreakBefore" 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<wbr/>Break<wbr/>Before</span><a href="#pageBreakBefore" 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">page<wbr/>Break<wbr/>Before</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#pageBreakBefore">pageBreakBefore</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L54">file/paragraph/properties.ts:54</a></li></ul></aside></section><section class="tsd-panel tsd-member 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 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">right<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="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#rightTabStop">rightTabStop</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L24">file/paragraph/properties.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="run" 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>run</span><a href="#run" 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">run</span><span class="tsd-signature-symbol">?:</span> <a href="IRunOptions.html" class="tsd-signature-type tsd-kind-interface">IRunOptions</a></div><div class="tsd-comment tsd-typography"><p>Reference: ECMA-376, 3rd Edition (June, 2011), Fundamentals and Markup Language Reference § 17.3.1.29.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#run">run</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L75">file/paragraph/properties.ts:75</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="scale" 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>scale</span><a href="#scale" 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">scale</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#scale">scale</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L66">file/paragraph/properties.ts:66</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="shading" 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>shading</span><a href="#shading" 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">shading</span><span class="tsd-signature-symbol">?:</span> <a href="IShadingAttributesProperties.html" class="tsd-signature-type tsd-kind-interface">IShadingAttributesProperties</a></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#shading">shading</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L60">file/paragraph/properties.ts:60</a></li></ul></aside></section><section class="tsd-panel tsd-member 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 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">spacing</span><span class="tsd-signature-symbol">?:</span> <a href="ISpacingProperties.html" class="tsd-signature-type tsd-kind-interface">ISpacingProperties</a></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#spacing">spacing</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L27">file/paragraph/properties.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="style" 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>style</span><a href="#style" 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">style</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#style">style</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L56">file/paragraph/properties.ts:56</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="suppressLineNumbers" 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>suppress<wbr/>Line<wbr/>Numbers</span><a href="#suppressLineNumbers" 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">suppress<wbr/>Line<wbr/>Numbers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#suppressLineNumbers">suppressLineNumbers</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L63">file/paragraph/properties.ts:63</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="tabStops" 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>tab<wbr/>Stops</span><a href="#tabStops" 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">tab<wbr/>Stops</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly </span><a href="TabStopDefinition.html" class="tsd-signature-type tsd-kind-interface">TabStopDefinition</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#tabStops">tabStops</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L55">file/paragraph/properties.ts:55</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="text" 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>text</span><a href="#text" 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">text</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/paragraph.ts#L41">file/paragraph/paragraph.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member 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 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">thematic<wbr/>Break</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#thematicBreak">thematicBreak</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L22">file/paragraph/properties.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="widowControl" 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>widow<wbr/>Control</span><a href="#widowControl" 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">widow<wbr/>Control</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#widowControl">widowControl</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L61">file/paragraph/properties.ts:61</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="wordWrap" 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>word<wbr/>Wrap</span><a href="#wordWrap" 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">word<wbr/>Wrap</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#wordWrap">wordWrap</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/paragraph/properties.ts#L64">file/paragraph/properties.ts:64</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#alignment" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>alignment</span></a><a href="#autoSpaceEastAsianText" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Space<wbr/>East<wbr/>Asian<wbr/>Text</span></a><a href="#bidirectional" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bidirectional</span></a><a href="#border" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>border</span></a><a href="#bullet" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bullet</span></a><a href="#children" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>children</span></a><a href="#contextualSpacing" class="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="#frame" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>frame</span></a><a href="#heading" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>heading</span></a><a href="#indent" class="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="#keepLines" class="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="#keepNext" class="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="#leftTabStop" class="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="#numbering" class="tsd-is-inherited"><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="#outlineLevel" class="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="#overflowPunctuation" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>overflow<wbr/>Punctuation</span></a><a href="#pageBreakBefore" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Break<wbr/>Before</span></a><a href="#rightTabStop" class="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="#run" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>run</span></a><a href="#scale" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scale</span></a><a href="#shading" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shading</span></a><a href="#spacing" class="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="#style" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style</span></a><a href="#suppressLineNumbers" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>suppress<wbr/>Line<wbr/>Numbers</span></a><a href="#tabStops" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tab<wbr/>Stops</span></a><a href="#text" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a><a href="#thematicBreak" class="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><a href="#widowControl" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>widow<wbr/>Control</span></a><a href="#wordWrap" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>word<wbr/>Wrap</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>docx</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html> |