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

Deploying to gh-pages from @ dolanmiu/docx@3d622c2ef1 🚀

Browse Source
This commit is contained in:
dolanmiu
2023-01-23 15:03:20 +00:00
parent 6aa0a58a4e
commit 4749e36fe2
357 changed files with 2005 additions and 1969 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
api/classes/TableOfContents.html
View File

@ -18,11 +18,11 @@
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><a href="XmlComponent.html" class="tsd-signature-type" data-tsd-kind="Class">XmlComponent</a>
<li><span class="tsd-signature-type">FileChild</span>
<ul class="tsd-hierarchy">
<li><span class="target">TableOfContents</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/03399ae/src/file/table-of-contents/table-of-contents.ts#L12">src/file/table-of-contents/table-of-contents.ts:12</a></li></ul></aside>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3d622c2/src/file/table-of-contents/table-of-contents.ts#L12">src/file/table-of-contents/table-of-contents.ts:12</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">
@ -33,6 +33,10 @@
<div class="tsd-index-list"><a href="TableOfContents.html#constructor" class="tsd-index-link tsd-kind-constructor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-512-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-512-text"></path></svg><span>constructor</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="TableOfContents.html#fileChild" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>file<wbr/>Child</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Methods</h3>
<div class="tsd-index-list"><a href="TableOfContents.html#addChildElement" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>add<wbr/>Child<wbr/>Element</span></a>
<a href="TableOfContents.html#prepForXml" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>prep<wbr/>For<wbr/>Xml</span></a>
@ -52,9 +56,17 @@
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> properties: <a href="../interfaces/ITableOfContentsOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ITableOfContentsOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="TableOfContents.html" class="tsd-signature-type" data-tsd-kind="Class">TableOfContents</a></h4><aside class="tsd-sources">
<p>Overrides <a href="XmlComponent.html">XmlComponent</a>.<a href="XmlComponent.html#constructor">constructor</a></p>
<p>Overrides FileChild.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/03399ae/src/file/table-of-contents/table-of-contents.ts#L13">src/file/table-of-contents/table-of-contents.ts:13</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3d622c2/src/file/table-of-contents/table-of-contents.ts#L13">src/file/table-of-contents/table-of-contents.ts:13</a></li></ul></aside></li></ul></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-class tsd-is-inherited"><a id="fileChild" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>file<wbr/>Child</span><a href="#fileChild" 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>
<div class="tsd-signature">file<wbr/>Child<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<p>Inherited from FileChild.fileChild</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3d622c2/src/file/file-child.ts#L4">src/file/file-child.ts:4</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addChildElement" class="tsd-anchor"></a>
@ -68,9 +80,9 @@
<li>
<h5>child: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="XmlComponent.html" class="tsd-signature-type" data-tsd-kind="Class">XmlComponent</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="XmlComponent.html" class="tsd-signature-type" data-tsd-kind="Class">XmlComponent</a></h4><aside class="tsd-sources">
<p>Inherited from <a href="XmlComponent.html">XmlComponent</a>.<a href="XmlComponent.html#addChildElement">addChildElement</a></p>
<p>Inherited from FileChild.addChildElement</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/03399ae/src/file/xml-components/xml-component.ts#L45">src/file/xml-components/xml-component.ts:45</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3d622c2/src/file/xml-components/xml-component.ts#L45">src/file/xml-components/xml-component.ts:45</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="prepForXml" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>prep<wbr/>For<wbr/>Xml</span><a href="#prepForXml" 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-method tsd-parent-kind-class tsd-is-inherited">
@ -82,9 +94,9 @@
<li>
<h5>context: <a href="../interfaces/IContext.html" class="tsd-signature-type" data-tsd-kind="Interface">IContext</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/IXmlableObject.html" class="tsd-signature-type" data-tsd-kind="Interface">IXmlableObject</a></h4><aside class="tsd-sources">
<p>Inherited from <a href="XmlComponent.html">XmlComponent</a>.<a href="XmlComponent.html#prepForXml">prepForXml</a></p>
<p>Inherited from FileChild.prepForXml</p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/03399ae/src/file/xml-components/xml-component.ts#L20">src/file/xml-components/xml-component.ts:20</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3d622c2/src/file/xml-components/xml-component.ts#L20">src/file/xml-components/xml-component.ts:20</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">
@ -109,6 +121,7 @@
<li class="current tsd-kind-class"><a href="TableOfContents.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Table<wbr/>Of<wbr/>Contents</span></a>
<ul>
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="TableOfContents.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TableOfContents.html#fileChild" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>file<wbr/>Child</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TableOfContents.html#addChildElement" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Child<wbr/>Element</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TableOfContents.html#prepForXml" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>prep<wbr/>For<wbr/>Xml</a></li></ul></li></ul></nav></div></div>
<div class="container tsd-generator">