2021-03-09 03:06:02 +00:00
<!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 = "Documentation for docx" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< / 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.json" 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 = "../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 >
2021-03-14 18:21:51 +00:00
< li class = "tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" > < a href = "iparagraphoptions.html#frame" class = "tsd-kind-icon" > frame< / a > < / li >
2021-03-09 03:06:02 +00:00
< 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#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 >
2021-03-13 04:23:47 +00:00
< 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 >
2021-03-09 03:06:02 +00:00
< / 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 name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L21" > src/file/paragraph/properties.ts:21< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L36" > src/file/paragraph/properties.ts:36< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 = "iborderoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > 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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L34" > src/file/paragraph/properties.ts:34< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L44" > src/file/paragraph/properties.ts:44< / a > < / li >
2021-03-09 03:06:02 +00:00
< / 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 name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/paragraph.ts#L31" > src/file/paragraph/paragraph.ts:31< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L23" > src/file/paragraph/properties.ts:23< / a > < / li >
2021-03-14 18:21:51 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L59" > src/file/paragraph/properties.ts:59< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L35" > src/file/paragraph/properties.ts:35< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L26" > src/file/paragraph/properties.ts:26< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L29" > src/file/paragraph/properties.ts:29< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L28" > src/file/paragraph/properties.ts:28< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L25" > src/file/paragraph/properties.ts:25< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "numbering" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > numbering< / h3 >
2021-03-12 04:09:15 +00:00
< 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 >
2021-03-09 03:06:02 +00:00
< aside class = "tsd-sources" >
< p > Inherited from < a href = "iparagraphpropertiesoptions.html" > IParagraphPropertiesOptions< / a > .< a href = "iparagraphpropertiesoptions.html#numbering" > numbering< / a > < / p >
< ul >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L47" > src/file/paragraph/properties.ts:47< / a > < / li >
2021-03-09 03:06:02 +00:00
< / 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 >
2021-03-12 04:09:15 +00:00
< 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 >
2021-03-09 03:06:02 +00:00
< 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 name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L30" > src/file/paragraph/properties.ts:30< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L37" > src/file/paragraph/properties.ts:37< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L24" > src/file/paragraph/properties.ts:24< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 > < span class = "tsd-signature-symbol" > { < / span > color< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > fill< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > type< span class = "tsd-signature-symbol" > : < / span > < a href = "../enums/shadingtype.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > ShadingType< / 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#shading" > shading< / a > < / p >
< ul >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L53" > src/file/paragraph/properties.ts:53< / a > < / li >
2021-03-09 03:06:02 +00:00
< / 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 > color< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > fill< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > type< span class = "tsd-signature-symbol" > : < / span > < a href = "../enums/shadingtype.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > ShadingType< / a > < / h5 >
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L27" > src/file/paragraph/properties.ts:27< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L43" > src/file/paragraph/properties.ts:43< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L38" > src/file/paragraph/properties.ts:38< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/paragraph.ts#L30" > src/file/paragraph/paragraph.ts:30< / a > < / li >
2021-03-09 03:06:02 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L22" > src/file/paragraph/properties.ts:22< / a > < / li >
2021-03-13 04:23:47 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a name = "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 >
2021-03-23 14:41:20 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/72389e2/src/file/paragraph/properties.ts#L58" > src/file/paragraph/properties.ts:58< / a > < / li >
2021-03-09 03:06:02 +00:00
< / 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 class = "before-current" >
< / ul >
< ul class = "current" >
< 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 >
2021-03-14 18:21:51 +00:00
< li class = " tsd-kind-property tsd-parent-kind-interface tsd-is-inherited" >
< a href = "iparagraphoptions.html#frame" class = "tsd-kind-icon" > frame< / a >
< / li >
2021-03-09 03:06:02 +00:00
< 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#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 >
2021-03-13 04:23:47 +00:00
< 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 >
2021-03-09 03:06:02 +00:00
< / 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-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 >
< / 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 >
< / body >
< / html >
