Files
docx-js/api/interfaces/isectionoptions.html
2021-06-09 00:05:50 +00:00

230 lines
12 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ISectionOptions | 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="isectionoptions.html">ISectionOptions</a>
</li>
</ul>
<h1>Interface ISectionOptions</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>
<span class="target">ISectionOptions</span>
</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"><a href="isectionoptions.html#children" class="tsd-kind-icon">children</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="isectionoptions.html#footers" class="tsd-kind-icon">footers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="isectionoptions.html#headers" class="tsd-kind-icon">headers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="isectionoptions.html#properties" class="tsd-kind-icon">properties</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">
<a name="children" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</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/paragraph.html" class="tsd-signature-type" data-tsd-kind="Class">Paragraph</a><span class="tsd-signature-symbol"> | </span><a href="../classes/table.html" class="tsd-signature-type" data-tsd-kind="Class">Table</a><span class="tsd-signature-symbol"> | </span><a href="../classes/tableofcontents.html" class="tsd-signature-type" data-tsd-kind="Class">TableOfContents</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/db20efa/src/file/file.ts#L35">src/file/file.ts:35</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="footers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> footers</h3>
<div class="tsd-signature tsd-kind-icon">footers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>default<span class="tsd-signature-symbol">?: </span><a href="../classes/footer.html" class="tsd-signature-type" data-tsd-kind="Class">Footer</a><span class="tsd-signature-symbol">; </span>even<span class="tsd-signature-symbol">?: </span><a href="../classes/footer.html" class="tsd-signature-type" data-tsd-kind="Class">Footer</a><span class="tsd-signature-symbol">; </span>first<span class="tsd-signature-symbol">?: </span><a href="../classes/footer.html" class="tsd-signature-type" data-tsd-kind="Class">Footer</a><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/db20efa/src/file/file.ts#L29">src/file/file.ts:29</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> default<span class="tsd-signature-symbol">?: </span><a href="../classes/footer.html" class="tsd-signature-type" data-tsd-kind="Class">Footer</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> even<span class="tsd-signature-symbol">?: </span><a href="../classes/footer.html" class="tsd-signature-type" data-tsd-kind="Class">Footer</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> first<span class="tsd-signature-symbol">?: </span><a href="../classes/footer.html" class="tsd-signature-type" data-tsd-kind="Class">Footer</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="headers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> headers</h3>
<div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>default<span class="tsd-signature-symbol">?: </span><a href="../classes/header.html" class="tsd-signature-type" data-tsd-kind="Class">Header</a><span class="tsd-signature-symbol">; </span>even<span class="tsd-signature-symbol">?: </span><a href="../classes/header.html" class="tsd-signature-type" data-tsd-kind="Class">Header</a><span class="tsd-signature-symbol">; </span>first<span class="tsd-signature-symbol">?: </span><a href="../classes/header.html" class="tsd-signature-type" data-tsd-kind="Class">Header</a><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/db20efa/src/file/file.ts#L24">src/file/file.ts:24</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> default<span class="tsd-signature-symbol">?: </span><a href="../classes/header.html" class="tsd-signature-type" data-tsd-kind="Class">Header</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> even<span class="tsd-signature-symbol">?: </span><a href="../classes/header.html" class="tsd-signature-type" data-tsd-kind="Class">Header</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> first<span class="tsd-signature-symbol">?: </span><a href="../classes/header.html" class="tsd-signature-type" data-tsd-kind="Class">Header</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="properties" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> properties</h3>
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <a href="isectionpropertiesoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ISectionPropertiesOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/db20efa/src/file/file.ts#L34">src/file/file.ts:34</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 class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="isectionoptions.html" class="tsd-kind-icon">ISection<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionoptions.html#children" class="tsd-kind-icon">children</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionoptions.html#footers" class="tsd-kind-icon">footers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionoptions.html#headers" class="tsd-kind-icon">headers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionoptions.html#properties" class="tsd-kind-icon">properties</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-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>