Files
docx-js/api/interfaces/IParagraphOptions.html
2022-01-11 19:50:23 +00:00

1 line
34 KiB
HTML

<!DOCTYPE html><html class="default"><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><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></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="IParagraphPropertiesOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IParagraphPropertiesOptions</a><ul class="tsd-hierarchy"><li><span class="target">IParagraphOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#alignment" class="tsd-kind-icon">alignment</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#bidirectional" class="tsd-kind-icon">bidirectional</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#border" class="tsd-kind-icon">border</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#bullet" class="tsd-kind-icon">bullet</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IParagraphOptions.html#children" class="tsd-kind-icon">children</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#contextualSpacing" class="tsd-kind-icon">contextual<wbr/>Spacing</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#frame" class="tsd-kind-icon">frame</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#heading" class="tsd-kind-icon">heading</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#indent" class="tsd-kind-icon">indent</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#keepLines" class="tsd-kind-icon">keep<wbr/>Lines</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#keepNext" class="tsd-kind-icon">keep<wbr/>Next</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#leftTabStop" class="tsd-kind-icon">left<wbr/>Tab<wbr/>Stop</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#numbering" class="tsd-kind-icon">numbering</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#outlineLevel" class="tsd-kind-icon">outline<wbr/>Level</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#pageBreakBefore" class="tsd-kind-icon">page<wbr/>Break<wbr/>Before</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#rightTabStop" class="tsd-kind-icon">right<wbr/>Tab<wbr/>Stop</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#shading" class="tsd-kind-icon">shading</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#spacing" class="tsd-kind-icon">spacing</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#style" class="tsd-kind-icon">style</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#suppressLineNumbers" class="tsd-kind-icon">suppress<wbr/>Line<wbr/>Numbers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#tabStops" class="tsd-kind-icon">tab<wbr/>Stops</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IParagraphOptions.html#text" class="tsd-kind-icon">text</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#thematicBreak" class="tsd-kind-icon">thematic<wbr/>Break</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#widowControl" class="tsd-kind-icon">widow<wbr/>Control</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="alignment" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> alignment</h3><div class="tsd-signature tsd-kind-icon">alignment<span class="tsd-signature-symbol">?:</span> <a href="../enums/AlignmentType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AlignmentType</a></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#alignment">alignment</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/paragraph/properties.ts#L18">src/file/paragraph/properties.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="bidirectional" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> bidirectional</h3><div class="tsd-signature tsd-kind-icon">bidirectional<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/df6b1c0/src/file/paragraph/properties.ts#L42">src/file/paragraph/properties.ts:42</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="border" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> border</h3><div class="tsd-signature tsd-kind-icon">border<span class="tsd-signature-symbol">?:</span> <a href="IBordersOptions.html" class="tsd-signature-type" data-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/df6b1c0/src/file/paragraph/properties.ts#L40">src/file/paragraph/properties.ts:40</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="bullet" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> bullet</h3><div class="tsd-signature tsd-kind-icon">bullet<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></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/df6b1c0/src/file/paragraph/properties.ts#L50">src/file/paragraph/properties.ts:50</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagReadonly">Readonly</span> level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="children" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> children</h3><div class="tsd-signature tsd-kind-icon">children<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#ParagraphChild" class="tsd-signature-type" data-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/df6b1c0/src/file/paragraph/paragraph.ts#L34">src/file/paragraph/paragraph.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="contextualSpacing" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> contextual<wbr/>Spacing</h3><div class="tsd-signature tsd-kind-icon">contextual<wbr/>Spacing<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#contextualSpacing">contextualSpacing</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/paragraph/properties.ts#L20">src/file/paragraph/properties.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="frame" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> frame</h3><div class="tsd-signature tsd-kind-icon">frame<span class="tsd-signature-symbol">?:</span> <a href="IFrameOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">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/df6b1c0/src/file/paragraph/properties.ts#L55">src/file/paragraph/properties.ts:55</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="heading" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> heading</h3><div class="tsd-signature tsd-kind-icon">heading<span class="tsd-signature-symbol">?:</span> <a href="../enums/HeadingLevel.html" class="tsd-signature-type" data-tsd-kind="Enumeration">HeadingLevel</a></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/df6b1c0/src/file/paragraph/properties.ts#L41">src/file/paragraph/properties.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="indent" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> indent</h3><div class="tsd-signature tsd-kind-icon">indent<span class="tsd-signature-symbol">?:</span> <a href="IIndentAttributesProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">IIndentAttributesProperties</a></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#indent">indent</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/paragraph/properties.ts#L23">src/file/paragraph/properties.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="keepLines" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> keep<wbr/>Lines</h3><div class="tsd-signature tsd-kind-icon">keep<wbr/>Lines<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#keepLines">keepLines</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/paragraph/properties.ts#L26">src/file/paragraph/properties.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="keepNext" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> keep<wbr/>Next</h3><div class="tsd-signature tsd-kind-icon">keep<wbr/>Next<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#keepNext">keepNext</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/paragraph/properties.ts#L25">src/file/paragraph/properties.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="leftTabStop" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> left<wbr/>Tab<wbr/>Stop</h3><div class="tsd-signature tsd-kind-icon">left<wbr/>Tab<wbr/>Stop<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#leftTabStop">leftTabStop</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/paragraph/properties.ts#L22">src/file/paragraph/properties.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="numbering" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> numbering</h3><div class="tsd-signature tsd-kind-icon">numbering<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>custom<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>instance<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>reference<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></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/df6b1c0/src/file/paragraph/properties.ts#L31">src/file/paragraph/properties.ts:31</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> custom<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> instance<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagReadonly">Readonly</span> level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagReadonly">Readonly</span> reference<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outlineLevel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> outline<wbr/>Level</h3><div class="tsd-signature tsd-kind-icon">outline<wbr/>Level<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#outlineLevel">outlineLevel</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/paragraph/properties.ts#L27">src/file/paragraph/properties.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="pageBreakBefore" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> page<wbr/>Break<wbr/>Before</h3><div class="tsd-signature tsd-kind-icon">page<wbr/>Break<wbr/>Before<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/df6b1c0/src/file/paragraph/properties.ts#L43">src/file/paragraph/properties.ts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="rightTabStop" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> right<wbr/>Tab<wbr/>Stop</h3><div class="tsd-signature tsd-kind-icon">right<wbr/>Tab<wbr/>Stop<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#rightTabStop">rightTabStop</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/paragraph/properties.ts#L21">src/file/paragraph/properties.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="shading" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> shading</h3><div class="tsd-signature tsd-kind-icon">shading<span class="tsd-signature-symbol">?:</span> <a href="IShadingAttributesProperties.html" class="tsd-signature-type" data-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/df6b1c0/src/file/paragraph/properties.ts#L53">src/file/paragraph/properties.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="spacing" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> spacing</h3><div class="tsd-signature tsd-kind-icon">spacing<span class="tsd-signature-symbol">?:</span> <a href="ISpacingProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">ISpacingProperties</a></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#spacing">spacing</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/paragraph/properties.ts#L24">src/file/paragraph/properties.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="style" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> style</h3><div class="tsd-signature tsd-kind-icon">style<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/df6b1c0/src/file/paragraph/properties.ts#L49">src/file/paragraph/properties.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="suppressLineNumbers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> suppress<wbr/>Line<wbr/>Numbers</h3><div class="tsd-signature tsd-kind-icon">suppress<wbr/>Line<wbr/>Numbers<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/df6b1c0/src/file/paragraph/properties.ts#L56">src/file/paragraph/properties.ts:56</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="tabStops" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> tab<wbr/>Stops</h3><div class="tsd-signature tsd-kind-icon">tab<wbr/>Stops<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>leader<span class="tsd-signature-symbol">?: </span><a href="../enums/LeaderType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">LeaderType</a><span class="tsd-signature-symbol">; </span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="../enums/TabStopType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TabStopType</a><span class="tsd-signature-symbol"> }</span><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/df6b1c0/src/file/paragraph/properties.ts#L44">src/file/paragraph/properties.ts:44</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="text" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> text</h3><div class="tsd-signature tsd-kind-icon">text<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/df6b1c0/src/file/paragraph/paragraph.ts#L33">src/file/paragraph/paragraph.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="thematicBreak" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> thematic<wbr/>Break</h3><div class="tsd-signature tsd-kind-icon">thematic<wbr/>Break<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IParagraphPropertiesOptions.html">IParagraphPropertiesOptions</a>.<a href="IParagraphPropertiesOptions.html#thematicBreak">thematicBreak</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/paragraph/properties.ts#L19">src/file/paragraph/properties.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="widowControl" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> widow<wbr/>Control</h3><div class="tsd-signature tsd-kind-icon">widow<wbr/>Control<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/df6b1c0/src/file/paragraph/properties.ts#L54">src/file/paragraph/properties.ts:54</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="IParagraphOptions.html" class="tsd-kind-icon">IParagraph<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#alignment" class="tsd-kind-icon">alignment</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#bidirectional" class="tsd-kind-icon">bidirectional</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#border" class="tsd-kind-icon">border</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#bullet" class="tsd-kind-icon">bullet</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IParagraphOptions.html#children" class="tsd-kind-icon">children</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#contextualSpacing" class="tsd-kind-icon">contextual<wbr/>Spacing</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#frame" class="tsd-kind-icon">frame</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#heading" class="tsd-kind-icon">heading</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#indent" class="tsd-kind-icon">indent</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#keepLines" class="tsd-kind-icon">keep<wbr/>Lines</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#keepNext" class="tsd-kind-icon">keep<wbr/>Next</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#leftTabStop" class="tsd-kind-icon">left<wbr/>Tab<wbr/>Stop</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#numbering" class="tsd-kind-icon">numbering</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#outlineLevel" class="tsd-kind-icon">outline<wbr/>Level</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#pageBreakBefore" class="tsd-kind-icon">page<wbr/>Break<wbr/>Before</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#rightTabStop" class="tsd-kind-icon">right<wbr/>Tab<wbr/>Stop</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#shading" class="tsd-kind-icon">shading</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#spacing" class="tsd-kind-icon">spacing</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#style" class="tsd-kind-icon">style</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#suppressLineNumbers" class="tsd-kind-icon">suppress<wbr/>Line<wbr/>Numbers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#tabStops" class="tsd-kind-icon">tab<wbr/>Stops</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IParagraphOptions.html#text" class="tsd-kind-icon">text</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#thematicBreak" class="tsd-kind-icon">thematic<wbr/>Break</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IParagraphOptions.html#widowControl" class="tsd-kind-icon">widow<wbr/>Control</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>