smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
0e4268752f71a9c1976814a0b5e73f6e2bdf4f38
docx-js/api/classes/ImportedXmlComponent.html

11 lines
34 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ dolanmiu/docx@a3c796aae39308d1917207ce2c0d195a76a1c744 🚀
2023-12-25 02:55:46 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ImportedXmlComponent | docx</title><meta name="description" content="Documentation for docx"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">docx</a></li><li><a href="ImportedXmlComponent.html">ImportedXmlComponent</a></li></ul><h1>Class ImportedXmlComponent</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents imported xml component from xml file.</p>
Deploying to gh-pages from @ dolanmiu/docx@ef7b930d4d823783ced4bdb8727d3d403652dddc 🚀
2024-10-09 20:27:38 +00:00
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#ImportedXmlComponent">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="XmlComponent.html" class="tsd-signature-type tsd-kind-class">XmlComponent</a><ul class="tsd-hierarchy"><li><span class="target">ImportedXmlComponent</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/ef7b930/src/file/xml-components/imported-xml-component.ts#L45">file/xml-components/imported-xml-component.ts:45</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"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="ImportedXmlComponent.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
Deploying to gh-pages from @ dolanmiu/docx@a3c796aae39308d1917207ce2c0d195a76a1c744 🚀
2023-12-25 02:55:46 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="ImportedXmlComponent.html#addChildElement" class="tsd-index-link deprecated tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Child<wbr/>Element</span></a>
Deploying to gh-pages from @ dolanmiu/docx@adbb16f7eb37fdad4808e158aa0a5fe22f8471fc 🚀
2023-06-13 18:37:09 +00:00
<a href="ImportedXmlComponent.html#prepForXml" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prep<wbr/>For<wbr/>Xml</span></a>
<a href="ImportedXmlComponent.html#push" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>push</span></a>
<a href="ImportedXmlComponent.html#fromXmlString" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Xml<wbr/>String</span></a>
Deploying to gh-pages from @ dolanmiu/docx@a3c796aae39308d1917207ce2c0d195a76a1c744 🚀
2023-12-25 02:55:46 +00:00
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ImportedXmlComponent" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Imported<wbr/>Xml<wbr/>Component</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">rootKey</span>, <span class="tsd-kind-parameter">_attr</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ImportedXmlComponent.html" class="tsd-signature-type tsd-kind-class">ImportedXmlComponent</a><a href="#constructor.new_ImportedXmlComponent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts the xml string to a XmlComponent tree.</p>
Deploying to gh-pages from @ dolanmiu/docx@ef7b930d4d823783ced4bdb8727d3d403652dddc 🚀
2024-10-09 20:27:38 +00:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">rootKey</span>: <span class="tsd-signature-type">string</span></h5></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">_attr</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ImportedXmlComponent.html" class="tsd-signature-type tsd-kind-class">ImportedXmlComponent</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="XmlComponent.html">XmlComponent</a>.<a href="XmlComponent.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/ef7b930/src/file/xml-components/imported-xml-component.ts#L62">file/xml-components/imported-xml-component.ts:62</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="addChildElement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">add<wbr/>Child<wbr/>Element</span><a href="#addChildElement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="addChildElement.addChildElement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Child<wbr/>Element</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="XmlComponent.html" class="tsd-signature-type tsd-kind-class">XmlComponent</a><a href="#addChildElement.addChildElement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></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><span class="tsd-kind-parameter">child</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="XmlComponent.html" class="tsd-signature-type tsd-kind-class">XmlComponent</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="XmlComponent.html" class="tsd-signature-type tsd-kind-class">XmlComponent</a></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4><p>Do not use this method. It is only used internally by the library. It will be removed in a future version.</p>
</div><aside class="tsd-sources"><p>Inherited from <a href="XmlComponent.html">XmlComponent</a>.<a href="XmlComponent.html#addChildElement">addChildElement</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/ef7b930/src/file/xml-components/xml-component.ts#L48">file/xml-components/xml-component.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member 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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="prepForXml.prepForXml-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">prep<wbr/>For<wbr/>Xml</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/IXmlableObject.html" class="tsd-signature-type tsd-kind-interface">IXmlableObject</a><a href="#prepForXml.prepForXml-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></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><span class="tsd-kind-parameter">context</span>: <a href="../interfaces/IContext.html" class="tsd-signature-type 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 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><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/ef7b930/src/file/xml-components/xml-component.ts#L20">file/xml-components/xml-component.ts:20</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="push" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>push</span><a href="#push" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="push.push-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">push</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">xmlComponent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#push.push-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></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><span class="tsd-kind-parameter">xmlComponent</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="XmlComponent.html" class="tsd-signature-type tsd-kind-class">XmlComponent</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/ef7b930/src/file/xml-components/imported-xml-component.ts#L70">file/xml-components/imported-xml-component.ts:70</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromXmlString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Xml<wbr/>String</span><a href="#fromXmlString" aria-label="Permalink" class="tsd-anchor-icon"><svg view
Deploying to gh-pages from @ dolanmiu/docx@a3c796aae39308d1917207ce2c0d195a76a1c744 🚀
2023-12-25 02:55:46 +00:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">importedContent</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>xml content of the imported component</p>
Deploying to gh-pages from @ dolanmiu/docx@ef7b930d4d823783ced4bdb8727d3d403652dddc 🚀
2024-10-09 20:27:38 +00:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ImportedXmlComponent.html" class="tsd-signature-type tsd-kind-class">ImportedXmlComponent</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/ef7b930/src/file/xml-components/imported-xml-component.ts#L51">file/xml-components/imported-xml-component.ts:51</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><ul><li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li><li><a href="#addChildElement" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Child<wbr/>Element</span></a></li><li><a href="#prepForXml" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prep<wbr/>For<wbr/>Xml</span></a></li><li><a href="#push" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>push</span></a></li><li><a href="#fromXmlString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Xml<wbr/>String</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>docx</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li><a href="../modules.html#File"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg>File</a></li><li><a href="AbstractNumbering.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AbstractNumbering</a></li><li><a href="Alignment.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Alignment</a></li><li><a href="AlignmentAttributes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>A
Reference in New Issue Copy Permalink