smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ dolanmiu/docx@91e8295648 🚀

Browse Source
This commit is contained in:
dolanmiu
2023-03-17 01:28:03 +00:00
parent b440946f68
commit 63fd886e64
363 changed files with 1954 additions and 2359 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
api/classes/Document.html
View File

@ -20,7 +20,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">Document</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L37">src/file/file.ts:37</a></li></ul></aside>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L36">src/file/file.ts:36</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@ -52,18 +52,16 @@
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-anchor-link" id="constructor.new_Document">new <wbr/>Document<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IPropertiesOptions</span>, fileProperties<span class="tsd-signature-symbol">?: </span><a href="../interfaces/IFileProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">IFileProperties</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Document.html" class="tsd-signature-type" data-tsd-kind="Class">Document</a><a href="#constructor.new_Document" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="constructor.new_Document">new <wbr/>Document<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IPropertiesOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Document.html" class="tsd-signature-type" data-tsd-kind="Class">Document</a><a href="#constructor.new_Document" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>options: <span class="tsd-signature-type">IPropertiesOptions</span></h5></li>
<li>
<h5>fileProperties: <a href="../interfaces/IFileProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">IFileProperties</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
<h5>options: <span class="tsd-signature-type">IPropertiesOptions</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Document.html" class="tsd-signature-type" data-tsd-kind="Class">Document</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L58">src/file/file.ts:58</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L57">src/file/file.ts:57</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="AppProperties" class="tsd-anchor"></a>
@ -73,7 +71,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AppProperties</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L297">src/file/file.ts:297</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L273">src/file/file.ts:273</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="Comments" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Comments</span><a href="#Comments" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -81,7 +79,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="Comments.html" class="tsd-signature-type" data-tsd-kind="Class">Comments</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L309">src/file/file.ts:309</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L285">src/file/file.ts:285</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="ContentTypes" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Content<wbr/>Types</span><a href="#ContentTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -89,7 +87,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ContentTypes</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L289">src/file/file.ts:289</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L265">src/file/file.ts:265</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="CoreProperties" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Core<wbr/>Properties</span><a href="#CoreProperties" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -97,7 +95,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CoreProperties</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L265">src/file/file.ts:265</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L241">src/file/file.ts:241</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="CustomProperties" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Custom<wbr/>Properties</span><a href="#CustomProperties" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -105,7 +103,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CustomProperties</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L293">src/file/file.ts:293</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L269">src/file/file.ts:269</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="Document" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Document</span><a href="#Document" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -113,7 +111,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DocumentWrapper</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L257">src/file/file.ts:257</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L233">src/file/file.ts:233</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="FileRelationships" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>File<wbr/>Relationships</span><a href="#FileRelationships" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -121,7 +119,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Relationships</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L277">src/file/file.ts:277</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L253">src/file/file.ts:253</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="FootNotes" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Foot<wbr/>Notes</span><a href="#FootNotes" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -129,7 +127,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FootnotesWrapper</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L301">src/file/file.ts:301</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L277">src/file/file.ts:277</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="Footers" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Footers</span><a href="#Footers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -137,7 +135,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="FooterWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">FooterWrapper</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L285">src/file/file.ts:285</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L261">src/file/file.ts:261</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="Headers" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Headers</span><a href="#Headers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -145,7 +143,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">readonly </span><a href="HeaderWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">HeaderWrapper</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L281">src/file/file.ts:281</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L257">src/file/file.ts:257</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="Media" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Media</span><a href="#Media" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -153,7 +151,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L273">src/file/file.ts:273</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L249">src/file/file.ts:249</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="Numbering" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Numbering</span><a href="#Numbering" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -161,7 +159,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="Numbering.html" class="tsd-signature-type" data-tsd-kind="Class">Numbering</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L269">src/file/file.ts:269</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L245">src/file/file.ts:245</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="Settings" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Settings</span><a href="#Settings" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -169,7 +167,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Settings</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L305">src/file/file.ts:305</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L281">src/file/file.ts:281</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="Styles" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Styles</span><a href="#Styles" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
@ -177,7 +175,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="Styles.html" class="tsd-signature-type" data-tsd-kind="Class">Styles</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a07d637/src/file/file.ts#L261">src/file/file.ts:261</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/91e8295/src/file/file.ts#L237">src/file/file.ts:237</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">