953 lines
57 KiB
HTML
953 lines
57 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>File | 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="file.html">File</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class File</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">File</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 tsd-is-external">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="file.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-external">
|
|
<h3>Accessors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#appproperties" class="tsd-kind-icon">App<wbr>Properties</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#contenttypes" class="tsd-kind-icon">Content<wbr>Types</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#coreproperties" class="tsd-kind-icon">Core<wbr>Properties</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#document" class="tsd-kind-icon">Document</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#documentrelationships" class="tsd-kind-icon">Document<wbr>Relationships</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#filerelationships" class="tsd-kind-icon">File<wbr>Relationships</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#footnotes" class="tsd-kind-icon">Foot<wbr>Notes</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#footer" class="tsd-kind-icon">Footer</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#footers" class="tsd-kind-icon">Footers</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#header" class="tsd-kind-icon">Header</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#headers" class="tsd-kind-icon">Headers</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#media" class="tsd-kind-icon">Media</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#numbering" class="tsd-kind-icon">Numbering</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#styles" class="tsd-kind-icon">Styles</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-external">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#footerbyrefnumber" class="tsd-kind-icon">Footer<wbr>ByRef<wbr>Number</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#headerbyrefnumber" class="tsd-kind-icon">Header<wbr>ByRef<wbr>Number</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#addimage" class="tsd-kind-icon">add<wbr>Image</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#addparagraph" class="tsd-kind-icon">add<wbr>Paragraph</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#addsection" class="tsd-kind-icon">add<wbr>Section</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#addtable" class="tsd-kind-icon">add<wbr>Table</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createbookmark" class="tsd-kind-icon">create<wbr>Bookmark</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createfirstpageheader" class="tsd-kind-icon">create<wbr>First<wbr>Page<wbr>Header</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createfooter" class="tsd-kind-icon">create<wbr>Footer</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createfootnote" class="tsd-kind-icon">create<wbr>Footnote</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createheader" class="tsd-kind-icon">create<wbr>Header</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createhyperlink" class="tsd-kind-icon">create<wbr>Hyperlink</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createimage" class="tsd-kind-icon">create<wbr>Image</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createinternalhyperlink" class="tsd-kind-icon">create<wbr>Internal<wbr>Hyper<wbr>Link</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createparagraph" class="tsd-kind-icon">create<wbr>Paragraph</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createtable" class="tsd-kind-icon">create<wbr>Table</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>File<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ipropertiesoptions.html" class="tsd-signature-type">IPropertiesOptions</a>, sectionPropertiesOptions<span class="tsd-signature-symbol">?: </span><a href="../globals.html#sectionpropertiesoptions" class="tsd-signature-type">SectionPropertiesOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="file.html" class="tsd-signature-type">File</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L33">file/file.ts:33</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/ipropertiesoptions.html" class="tsd-signature-type">IPropertiesOptions</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> sectionPropertiesOptions: <a href="../globals.html#sectionpropertiesoptions" class="tsd-signature-type">SectionPropertiesOptions</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="file.html" class="tsd-signature-type">File</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Accessors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="appproperties" class="tsd-anchor"></a>
|
|
<h3>App<wbr>Properties</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> AppProperties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="appproperties.html" class="tsd-signature-type">AppProperties</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L273">file/file.ts:273</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="appproperties.html" class="tsd-signature-type">AppProperties</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="contenttypes" class="tsd-anchor"></a>
|
|
<h3>Content<wbr>Types</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> ContentTypes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="contenttypes.html" class="tsd-signature-type">ContentTypes</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L269">file/file.ts:269</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="contenttypes.html" class="tsd-signature-type">ContentTypes</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="coreproperties" class="tsd-anchor"></a>
|
|
<h3>Core<wbr>Properties</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> CoreProperties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coreproperties.html" class="tsd-signature-type">CoreProperties</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L217">file/file.ts:217</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="coreproperties.html" class="tsd-signature-type">CoreProperties</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="document" class="tsd-anchor"></a>
|
|
<h3>Document</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Document<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="document.html" class="tsd-signature-type">Document</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L209">file/file.ts:209</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="document.html" class="tsd-signature-type">Document</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="documentrelationships" class="tsd-anchor"></a>
|
|
<h3>Document<wbr>Relationships</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> DocumentRelationships<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="relationships.html" class="tsd-signature-type">Relationships</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L229">file/file.ts:229</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="relationships.html" class="tsd-signature-type">Relationships</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="filerelationships" class="tsd-anchor"></a>
|
|
<h3>File<wbr>Relationships</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> FileRelationships<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="relationships.html" class="tsd-signature-type">Relationships</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L233">file/file.ts:233</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="relationships.html" class="tsd-signature-type">Relationships</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="footnotes" class="tsd-anchor"></a>
|
|
<h3>Foot<wbr>Notes</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> FootNotes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="footnotes.html" class="tsd-signature-type">FootNotes</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L277">file/file.ts:277</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="footnotes.html" class="tsd-signature-type">FootNotes</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="footer" class="tsd-anchor"></a>
|
|
<h3>Footer</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Footer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="footerwrapper.html" class="tsd-signature-type">FooterWrapper</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L253">file/file.ts:253</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="footerwrapper.html" class="tsd-signature-type">FooterWrapper</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="footers" class="tsd-anchor"></a>
|
|
<h3>Footers</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Footers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="footerwrapper.html" class="tsd-signature-type">FooterWrapper</a><span class="tsd-signature-symbol">[]</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L257">file/file.ts:257</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="footerwrapper.html" class="tsd-signature-type">FooterWrapper</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="header" class="tsd-anchor"></a>
|
|
<h3>Header</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Header<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L237">file/file.ts:237</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="headers" class="tsd-anchor"></a>
|
|
<h3>Headers</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Headers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a><span class="tsd-signature-symbol">[]</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L241">file/file.ts:241</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="media" class="tsd-anchor"></a>
|
|
<h3>Media</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Media<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="media.html" class="tsd-signature-type">Media</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L225">file/file.ts:225</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="media.html" class="tsd-signature-type">Media</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="numbering" class="tsd-anchor"></a>
|
|
<h3>Numbering</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Numbering<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="numbering.html" class="tsd-signature-type">Numbering</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L221">file/file.ts:221</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="numbering.html" class="tsd-signature-type">Numbering</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a name="styles" class="tsd-anchor"></a>
|
|
<h3>Styles</h3>
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Styles<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="styles.html" class="tsd-signature-type">Styles</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L213">file/file.ts:213</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="styles.html" class="tsd-signature-type">Styles</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="footerbyrefnumber" class="tsd-anchor"></a>
|
|
<h3>Footer<wbr>ByRef<wbr>Number</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">Footer<wbr>ByRef<wbr>Number<span class="tsd-signature-symbol">(</span>refId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="footerwrapper.html" class="tsd-signature-type">FooterWrapper</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L261">file/file.ts:261</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>refId: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="footerwrapper.html" class="tsd-signature-type">FooterWrapper</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="headerbyrefnumber" class="tsd-anchor"></a>
|
|
<h3>Header<wbr>ByRef<wbr>Number</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">Header<wbr>ByRef<wbr>Number<span class="tsd-signature-symbol">(</span>refId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L245">file/file.ts:245</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>refId: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="addimage" class="tsd-anchor"></a>
|
|
<h3>add<wbr>Image</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Image<span class="tsd-signature-symbol">(</span>image<span class="tsd-signature-symbol">: </span><a href="image.html" class="tsd-signature-type">Image</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="file.html" class="tsd-signature-type">File</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L126">file/file.ts:126</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>image: <a href="image.html" class="tsd-signature-type">Image</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="file.html" class="tsd-signature-type">File</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="addparagraph" class="tsd-anchor"></a>
|
|
<h3>add<wbr>Paragraph</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Paragraph<span class="tsd-signature-symbol">(</span>paragraph<span class="tsd-signature-symbol">: </span><a href="paragraph.html" class="tsd-signature-type">Paragraph</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L110">file/file.ts:110</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>paragraph: <a href="paragraph.html" class="tsd-signature-type">Paragraph</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="addsection" class="tsd-anchor"></a>
|
|
<h3>add<wbr>Section</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Section<span class="tsd-signature-symbol">(</span>sectionPropertiesOptions<span class="tsd-signature-symbol">: </span><a href="../globals.html#sectionpropertiesoptions" class="tsd-signature-type">SectionPropertiesOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L164">file/file.ts:164</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>sectionPropertiesOptions: <a href="../globals.html#sectionpropertiesoptions" class="tsd-signature-type">SectionPropertiesOptions</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="addtable" class="tsd-anchor"></a>
|
|
<h3>add<wbr>Table</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Table<span class="tsd-signature-symbol">(</span>table<span class="tsd-signature-symbol">: </span><a href="table.html" class="tsd-signature-type">Table</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L118">file/file.ts:118</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>table: <a href="table.html" class="tsd-signature-type">Table</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="createbookmark" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Bookmark</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Bookmark<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, 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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="bookmark.html" class="tsd-signature-type">Bookmark</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L158">file/file.ts:158</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> text: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="bookmark.html" class="tsd-signature-type">Bookmark</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="createfirstpageheader" class="tsd-anchor"></a>
|
|
<h3>create<wbr>First<wbr>Page<wbr>Header</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>First<wbr>Page<wbr>Header<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L196">file/file.ts:196</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="createfooter" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Footer</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Footer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="footerwrapper.html" class="tsd-signature-type">FooterWrapper</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L184">file/file.ts:184</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="footerwrapper.html" class="tsd-signature-type">FooterWrapper</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="createfootnote" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Footnote</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Footnote<span class="tsd-signature-symbol">(</span>paragraph<span class="tsd-signature-symbol">: </span><a href="paragraph.html" class="tsd-signature-type">Paragraph</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L168">file/file.ts:168</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>paragraph: <a href="paragraph.html" class="tsd-signature-type">Paragraph</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="createheader" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Header</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Header<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L172">file/file.ts:172</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="createhyperlink" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Hyperlink</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Hyperlink<span class="tsd-signature-symbol">(</span>link<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, 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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="hyperlink.html" class="tsd-signature-type">Hyperlink</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L138">file/file.ts:138</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>link: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> text: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="hyperlink.html" class="tsd-signature-type">Hyperlink</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="createimage" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Image</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Image<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span>, width<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>, height<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="image.html" class="tsd-signature-type">Image</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L131">file/file.ts:131</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>buffer: <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> width: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> height: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="image.html" class="tsd-signature-type">Image</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="createinternalhyperlink" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Internal<wbr>Hyper<wbr>Link</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Internal<wbr>Hyper<wbr>Link<span class="tsd-signature-symbol">(</span>anchor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, 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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="hyperlink.html" class="tsd-signature-type">Hyperlink</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L150">file/file.ts:150</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>anchor: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> text: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="hyperlink.html" class="tsd-signature-type">Hyperlink</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="createparagraph" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Paragraph</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Paragraph<span class="tsd-signature-symbol">(</span>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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="paragraph.html" class="tsd-signature-type">Paragraph</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L114">file/file.ts:114</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> text: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="paragraph.html" class="tsd-signature-type">Paragraph</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="createtable" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Table</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Table<span class="tsd-signature-symbol">(</span>rows<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, cols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="table.html" class="tsd-signature-type">Table</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/dc942bc/src/file/file.ts#L122">file/file.ts:122</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>rows: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>cols: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="table.html" class="tsd-signature-type">Table</a></h4>
|
|
</li>
|
|
</ul>
|
|
</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-class tsd-is-external">
|
|
<a href="file.html" class="tsd-kind-icon">File</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#appproperties" class="tsd-kind-icon">App<wbr>Properties</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#contenttypes" class="tsd-kind-icon">Content<wbr>Types</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#coreproperties" class="tsd-kind-icon">Core<wbr>Properties</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#document" class="tsd-kind-icon">Document</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#documentrelationships" class="tsd-kind-icon">Document<wbr>Relationships</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#filerelationships" class="tsd-kind-icon">File<wbr>Relationships</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#footnotes" class="tsd-kind-icon">Foot<wbr>Notes</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#footer" class="tsd-kind-icon">Footer</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#footers" class="tsd-kind-icon">Footers</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#header" class="tsd-kind-icon">Header</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#headers" class="tsd-kind-icon">Headers</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#media" class="tsd-kind-icon">Media</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#numbering" class="tsd-kind-icon">Numbering</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#styles" class="tsd-kind-icon">Styles</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#footerbyrefnumber" class="tsd-kind-icon">Footer<wbr>ByRef<wbr>Number</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#headerbyrefnumber" class="tsd-kind-icon">Header<wbr>ByRef<wbr>Number</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#addimage" class="tsd-kind-icon">add<wbr>Image</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#addparagraph" class="tsd-kind-icon">add<wbr>Paragraph</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#addsection" class="tsd-kind-icon">add<wbr>Section</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#addtable" class="tsd-kind-icon">add<wbr>Table</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#createbookmark" class="tsd-kind-icon">create<wbr>Bookmark</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#createfirstpageheader" class="tsd-kind-icon">create<wbr>First<wbr>Page<wbr>Header</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#createfooter" class="tsd-kind-icon">create<wbr>Footer</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#createfootnote" class="tsd-kind-icon">create<wbr>Footnote</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#createheader" class="tsd-kind-icon">create<wbr>Header</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#createhyperlink" class="tsd-kind-icon">create<wbr>Hyperlink</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#createimage" class="tsd-kind-icon">create<wbr>Image</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#createinternalhyperlink" class="tsd-kind-icon">create<wbr>Internal<wbr>Hyper<wbr>Link</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#createparagraph" class="tsd-kind-icon">create<wbr>Paragraph</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="file.html#createtable" class="tsd-kind-icon">create<wbr>Table</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>
|
|
</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="http://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> |