smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
11d2edcb3796ca4182828253adf06ba182e3fa1c
docx-js/api/variables/BorderStyle.html

65 lines
24 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ dolanmiu/docx@4e0468d9784b9386fd2769f67bdfbaeec28add5b 🚀
2025-04-16 07:59:44 +00:00
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BorderStyle | 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/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">docx</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BorderStyle</a></li></ul><h1>Variable BorderStyle<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">BorderStyle</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">DASH_DOT_STROKED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dashDotStroked&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">DASH_SMALL_GAP</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dashSmallGap&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">DASHED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dashed&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">DOT_DASH</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dotDash&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">DOT_DOT_DASH</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dotDotDash&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">DOTTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dotted&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">DOUBLE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;double&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">DOUBLE_WAVE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;doubl
Deploying to gh-pages from @ dolanmiu/docx@4d1a351649b80d1675019317f3ec04a59042c081 🚀
2025-04-14 11:14:19 +00:00
<p><code>bottom</code>, <code>end</code> (<code>right</code> in the previous version of the standard), <code>insideH</code>, <code>insideV</code>, <code>start</code> (<code>left</code> in the previous version of the standard), and <code>top</code>.</p>
<p>Reference: <a href="http://officeopenxml.com/WPtableBorders.php">http://officeopenxml.com/WPtableBorders.php</a></p>
Deploying to gh-pages from @ dolanmiu/docx@4e0468d9784b9386fd2769f67bdfbaeec28add5b 🚀
2025-04-16 07:59:44 +00:00
<h2 id="xsd-schema" class="tsd-anchor-link">XSD Schema<a href="#xsd-schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="xml"><xsd:simpleType name="ST_Border">
Deploying to gh-pages from @ dolanmiu/docx@4d1a351649b80d1675019317f3ec04a59042c081 🚀
2025-04-14 11:14:19 +00:00
<xsd:restriction base="xsd:string">
<xsd:enumeration value="single"/>
<xsd:enumeration value="dashDotStroked"/>
<xsd:enumeration value="dashed"/>
<xsd:enumeration value="dashSmallGap"/>
<xsd:enumeration value="dotDash"/>
<xsd:enumeration value="dotDotDash"/>
<xsd:enumeration value="dotted"/>
<xsd:enumeration value="double"/>
<xsd:enumeration value="doubleWave"/>
<xsd:enumeration value="inset"/>
<xsd:enumeration value="nil"/>
<xsd:enumeration value="none"/>
<xsd:enumeration value="outset"/>
<xsd:enumeration value="thick"/>
<xsd:enumeration value="thickThinLargeGap"/>
<xsd:enumeration value="thickThinMediumGap"/>
<xsd:enumeration value="thickThinSmallGap"/>
<xsd:enumeration value="thinThickLargeGap"/>
<xsd:enumeration value="thinThickMediumGap"/>
<xsd:enumeration value="thinThickSmallGap"/>
<xsd:enumeration value="thinThickThinLargeGap"/>
<xsd:enumeration value="thinThickThinMediumGap"/>
<xsd:enumeration value="thinThickThinSmallGap"/>
<xsd:enumeration value="threeDEmboss"/>
<xsd:enumeration value="threeDEngrave"/>
<xsd:enumeration value="triple"/>
<xsd:enumeration value="wave"/>
</xsd:restriction>
</xsd:simpleType>
</code><button type="button">Copy</button></pre>
Deploying to gh-pages from @ dolanmiu/docx@4e0468d9784b9386fd2769f67bdfbaeec28add5b 🚀
2025-04-16 07:59:44 +00:00
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5 id="dash_dot_stroked"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">DASH_DOT_STROKED</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;dashDotStroked&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a line with a series of alternating thin and thick strokes</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="dash_small_gap"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">DASH_SMALL_GAP</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;dashSmallGap&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a dashed line with small gaps</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="dashed"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">DASHED</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;dashed&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a dashed line</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="dot_dash"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">DOT_DASH</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;dotDash&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a line with alternating dots and dashes</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="dot_dot_dash"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">DOT_DOT_DASH</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;dotDotDash&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a line with a repeating dot - dot - dash sequence</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="dotted"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">DOTTED</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;dotted&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a dotted line</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="double"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">DOUBLE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;double&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a double line</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="double_wave"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">DOUBLE_WAVE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;doubleWave&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a double wavy line</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="inset"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">INSET</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;inset&quot;</span></h5><div class="tsd-comment tsd-typography"><p>an inset set of lines</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="nil"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">NIL</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;nil&quot;</span></h5><div class="tsd-comment tsd-typography"><p>no border</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="none"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">NONE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;none&quot;</span></h5><div class="tsd-comment tsd-typography"><p>no border</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="outset"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OUTSET</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;outset&quot;</span></h5><div class="tsd-comment tsd-typography"><p>an outset set of lines</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="single"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">SINGLE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;single&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a single line</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="thick"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">THICK</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;thick&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a single line</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="thick_thin_large_gap"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">THICK_THIN_LARGE_GAP</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;thickThinLargeGap&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a thick line contained within a thin line with a large-sized intermediate gap</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="thick_thin_medium_gap"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">THICK_THIN_MEDIUM_GAP</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;thickThinMediumGap&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a thick line contained within a thin line with a medium-sized intermediate gap</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="thick_thin_small_gap"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">THICK_THIN_SMALL_GAP</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;thickThinSmallGap&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a thick line contained within a thin line with a small intermediate gap</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="thin_thick_large_gap"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">THIN_THICK_LARGE_GAP</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;thinThickLargeGap&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a thin line contained within a thick line with a large-sized intermediate gap</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="thin_thick_medium_gap"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">THIN_THICK_MEDIUM_GAP</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;thinThickMediumGap&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a thick line contained within a thin line with a medium-sized intermediate gap</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="thin_thick_small_gap"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">THIN_THICK_SMALL_GAP</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;thinThickSmallGap&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a thick line contained within a thin line with a small intermediate gap</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="thin_thick_thin_large_gap"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">THIN_THICK_THIN_LARGE_GAP</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;thinThickThinLargeGap&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a thin-thick-thin line with a large gap</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="thin_thick_thin_medium_gap"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">THIN_THICK_THIN_MEDIUM_GAP</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;thinThickThinMediumGap&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a thin-thick-thin line with a medium gap</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="thin_thick_thin_small_gap"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">THIN_THICK_THIN_SMALL_GAP</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;thinThickThinSmallGap&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a thin-thick-thin line with a small gap</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="three_d_emboss"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">THREE_D_EMBOSS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;threeDEmboss&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a three-staged gradient line, getting darker towards the paragraph</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="three_d_engrave"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">THREE_D_ENGRAVE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;threeDEngrave&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a three-staged gradient like, getting darker away from the paragraph</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="triple"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">TRIPLE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;triple&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a triple line</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="wave"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">WAVE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;wave&quot;</span></h5><div class="tsd-comment tsd-typography"><p>a wavy line</p>
Deploying to gh-pages from @ dolanmiu/docx@a241a51cfdec5f37ce10b5a92e6934921d476747 🚀
2025-04-16 08:00:02 +00:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/a241a51cfdec5f37ce10b5a92e6934921d476747/src/file/border/border.ts#L100">file/border/border.ts:100</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><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></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><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-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#xsd-schema"><span>XSD <wbr/>Schema</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">docx</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
Reference in New Issue Copy Permalink