Files
docx-js/api/interfaces/iparagraphoptions.html

485 lines
36 KiB
HTML
Raw Normal View History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IParagraphOptions | docx</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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="../globals.html">Globals</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">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 tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphoptions.html#alignment" class="tsd-kind-icon">alignment</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphoptions.html#bidirectional" class="tsd-kind-icon">bidirectional</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphoptions.html#border" class="tsd-kind-icon">border</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphoptions.html#bullet" class="tsd-kind-icon">bullet</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="iparagraphoptions.html#children" class="tsd-kind-icon">children</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><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 tsd-is-external"><a href="iparagraphoptions.html#heading" class="tsd-kind-icon">heading</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphoptions.html#indent" class="tsd-kind-icon">indent</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><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 tsd-is-external"><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 tsd-is-external"><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 tsd-is-external"><a href="iparagraphoptions.html#numbering" class="tsd-kind-icon">numbering</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><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 tsd-is-external"><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 tsd-is-external"><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 tsd-is-external"><a href="iparagraphoptions.html#spacing" class="tsd-kind-icon">spacing</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphoptions.html#style" class="tsd-kind-icon">style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphoptions.html#tabstops" class="tsd-kind-icon">tab<wbr>Stops</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="iparagraphoptions.html#text" class="tsd-kind-icon">text</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphoptions.html#thematicbreak" class="tsd-kind-icon">thematic<wbr>Break</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="alignment" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">AlignmentType</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="iparagraphstylepropertiesoptions.html">IParagraphStylePropertiesOptions</a>.<a href="iparagraphstylepropertiesoptions.html#alignment">alignment</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33befaa/src/file/paragraph/properties.ts#L16">src/file/paragraph/properties.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="bidirectional" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> bidirectional</h3>
<div class="tsd-signature tsd-kind-icon">bidirectional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</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/33befaa/src/file/paragraph/properties.ts#L31">src/file/paragraph/properties.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="border" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> border</h3>
<div class="tsd-signature tsd-kind-icon">border<span class="tsd-signature-symbol">:</span> <a href="iborderoptions.html" class="tsd-signature-type">IBorderOptions</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/33befaa/src/file/paragraph/properties.ts#L29">src/file/paragraph/properties.ts:29</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="bullet" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> bullet</h3>
<div class="tsd-signature tsd-kind-icon">bullet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/33befaa/src/file/paragraph/properties.ts#L39">src/file/paragraph/properties.ts:39</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="children" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> children</h3>
<div class="tsd-signature tsd-kind-icon">children<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><a href="../classes/footnotereferencerun.html" class="tsd-signature-type">FootnoteReferenceRun</a><span class="tsd-signature-symbol"> | </span><a href="../classes/textrun.html" class="tsd-signature-type">TextRun</a><span class="tsd-signature-symbol"> | </span><a href="../classes/symbolrun.html" class="tsd-signature-type">SymbolRun</a><span class="tsd-signature-symbol"> | </span><a href="../classes/picturerun.html" class="tsd-signature-type">PictureRun</a><span class="tsd-signature-symbol"> | </span><a href="../classes/sequentialidentifier.html" class="tsd-signature-type">SequentialIdentifier</a><span class="tsd-signature-symbol"> | </span><a href="../classes/pagebreak.html" class="tsd-signature-type">PageBreak</a><span class="tsd-signature-symbol"> | </span><a href="../classes/hyperlinkref.html" class="tsd-signature-type">HyperlinkRef</a><span class="tsd-signature-symbol"> | </span><a href="../classes/bookmark.html" class="tsd-signature-type">Bookmark</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33befaa/src/file/paragraph/paragraph.ts#L13">src/file/paragraph/paragraph.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="contextualspacing" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="iparagraphstylepropertiesoptions.html">IParagraphStylePropertiesOptions</a>.<a href="iparagraphstylepropertiesoptions.html#contextualspacing">contextualSpacing</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33befaa/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 tsd-is-external">
<a name="heading" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">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/33befaa/src/file/paragraph/properties.ts#L30">src/file/paragraph/properties.ts:30</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="indent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">IIndentAttributesProperties</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="iparagraphstylepropertiesoptions.html">IParagraphStylePropertiesOptions</a>.<a href="iparagraphstylepropertiesoptions.html#indent">indent</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33befaa/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 tsd-is-external">
<a name="keeplines" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="iparagraphstylepropertiesoptions.html">IParagraphStylePropertiesOptions</a>.<a href="iparagraphstylepropertiesoptions.html#keeplines">keepLines</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33befaa/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 tsd-is-external">
<a name="keepnext" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="iparagraphstylepropertiesoptions.html">IParagraphStylePropertiesOptions</a>.<a href="iparagraphstylepropertiesoptions.html#keepnext">keepNext</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33befaa/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 tsd-is-external">
<a name="lefttabstop" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="iparagraphstylepropertiesoptions.html">IParagraphStylePropertiesOptions</a>.<a href="iparagraphstylepropertiesoptions.html#lefttabstop">leftTabStop</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33befaa/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 tsd-is-external">
<a name="numbering" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> numbering</h3>
<div class="tsd-signature tsd-kind-icon">numbering<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>custom<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</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/33befaa/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 tsd-is-external">
<a name="outlinelevel" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="iparagraphstylepropertiesoptions.html">IParagraphStylePropertiesOptions</a>.<a href="iparagraphstylepropertiesoptions.html#outlinelevel">outlineLevel</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33befaa/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 tsd-is-external">
<a name="pagebreakbefore" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</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/33befaa/src/file/paragraph/properties.ts#L32">src/file/paragraph/properties.ts:32</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="righttabstop" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="iparagraphstylepropertiesoptions.html">IParagraphStylePropertiesOptions</a>.<a href="iparagraphstylepropertiesoptions.html#righttabstop">rightTabStop</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33befaa/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 tsd-is-external">
<a name="spacing" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">ISpacingProperties</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="iparagraphstylepropertiesoptions.html">IParagraphStylePropertiesOptions</a>.<a href="iparagraphstylepropertiesoptions.html#spacing">spacing</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33befaa/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 tsd-is-external">
<a name="style" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> style</h3>
<div class="tsd-signature tsd-kind-icon">style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</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/33befaa/src/file/paragraph/properties.ts#L38">src/file/paragraph/properties.ts:38</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="tabstops" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">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><a href="../enums/tabstopposition.html" class="tsd-signature-type">TabStopPosition</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="../enums/tabstoptype.html" class="tsd-signature-type">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/33befaa/src/file/paragraph/properties.ts#L33">src/file/paragraph/properties.ts:33</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="text" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> text</h3>
<div class="tsd-signature tsd-kind-icon">text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</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/33befaa/src/file/paragraph/paragraph.ts#L12">src/file/paragraph/paragraph.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="thematicbreak" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="iparagraphstylepropertiesoptions.html">IParagraphStylePropertiesOptions</a>.<a href="iparagraphstylepropertiesoptions.html#thematicbreak">thematicBreak</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/33befaa/src/file/paragraph/properties.ts#L17">src/file/paragraph/properties.ts:17</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="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-is-external">
<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 tsd-is-external">
<a href="iparagraphoptions.html#alignment" class="tsd-kind-icon">alignment</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphoptions.html#bidirectional" class="tsd-kind-icon">bidirectional</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphoptions.html#border" class="tsd-kind-icon">border</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphoptions.html#bullet" class="tsd-kind-icon">bullet</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="iparagraphoptions.html#children" class="tsd-kind-icon">children</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<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 tsd-is-external">
<a href="iparagraphoptions.html#heading" class="tsd-kind-icon">heading</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphoptions.html#indent" class="tsd-kind-icon">indent</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<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 tsd-is-external">
<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 tsd-is-external">
<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 tsd-is-external">
<a href="iparagraphoptions.html#numbering" class="tsd-kind-icon">numbering</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<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 tsd-is-external">
<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 tsd-is-external">
<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 tsd-is-external">
<a href="iparagraphoptions.html#spacing" class="tsd-kind-icon">spacing</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphoptions.html#style" class="tsd-kind-icon">style</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphoptions.html#tabstops" class="tsd-kind-icon">tab<wbr>Stops</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="iparagraphoptions.html#text" class="tsd-kind-icon">text</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphoptions.html#thematicbreak" class="tsd-kind-icon">thematic<wbr>Break</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</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>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</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-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</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/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>