2022-06-25 12:29:20 +00:00
|
|
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>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 async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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"><h1>docx </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>References</h3><ul class="tsd-index-list"><li class="tsd-kind-reference"><a href="modules.html#File" class="tsd-kind-icon">File</a></li></ul></section><section class="tsd-index-section "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum"><a href="enums/AlignmentType.html" class="tsd-kind-icon">Alignment<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/BorderStyle.html" class="tsd-kind-icon">Border<wbr/>Style</a></li><li class="tsd-kind-enum"><a href="enums/DocumentGridType.html" class="tsd-kind-icon">Document<wbr/>Grid<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/DropCapType.html" class="tsd-kind-icon">Drop<wbr/>Cap<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/EmphasisMarkType.html" class="tsd-kind-icon">Emphasis<wbr/>Mark<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/FrameAnchorType.html" class="tsd-kind-icon">Frame<wbr/>Anchor<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/FrameWrap.html" class="tsd-kind-icon">Frame<wbr/>Wrap</a></li><li class="tsd-kind-enum"><a href="enums/HeaderFooterReferenceType.html" class="tsd-kind-icon">Header<wbr/>Footer<wbr/>Reference<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/HeaderFooterType.html" class="tsd-kind-icon">Header<wbr/>Footer<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/HeadingLevel.html" class="tsd-kind-icon">Heading<wbr/>Level</a></li><li class="tsd-kind-enum"><a href="enums/HeightRule.html" class="tsd-kind-icon">Height<wbr/>Rule</a></li><li class="tsd-kind-enum"><a href="enums/HorizontalPositionAlign.html" class="tsd-kind-icon">Horizontal<wbr/>Position<wbr/>Align</a></li><li class="tsd-kind-enum"><a href="enums/HorizontalPositionRelativeFrom.html" class="tsd-kind-icon">Horizontal<wbr/>Position<wbr/>Relative<wbr/>From</a></li><li class="tsd-kind-enum"><a href="enums/HyperlinkType.html" class="tsd-kind-icon">Hyperlink<wbr/>Type</a></li><l
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>Converts the given xml element (in json format) into XmlComponent.</p>
|
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>element: <span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
<p>the xml element in json presentation</p>
|
2022-06-25 12:29:20 +00:00
|
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="classes/ImportedXmlComponent.html" class="tsd-signature-type" data-tsd-kind="Class">ImportedXmlComponent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="dateTimeValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link">date<wbr/>Time<wbr/>Value<a href="#dateTimeValue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">date<wbr/>Time<wbr/>Value<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/c19bc6b/src/file/values.ts#L224">src/file/values.ts:224</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>val: <span class="tsd-signature-type">Date</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="decimalNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link">decimal<wbr/>Number<a href="#decimalNumber" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">decimal<wbr/>Number<span class="tsd-signature-symbol">(</span>val<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><span class="tsd-signature-type">number</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/c19bc6b/src/file/values.ts#L10">src/file/values.ts:10</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>val: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="eighthPointMeasureValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link">eighth<wbr/>Point<wbr/>Measure<wbr/>Value<a href="#eighthPointMeasureValue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><ul cla
|