8 lines
17 KiB
HTML
8 lines
17 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IBorderOptions | 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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</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="../assets/icons.svg#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="../assets/icons.svg#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="IBorderOptions.html">IBorderOptions</a></li></ul><h1>Interface IBorderOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IBorderOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="IBorderOptions.html#color">color</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IBorderOptions.html#size">size</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IBorderOptions.html#space">space</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="IBorderOptions.html#style">style</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"nil"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"single"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dashDotStroked"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dashed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dashSmallGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dotDash"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dotDotDash"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dotted"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"double"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"doubleWave"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"inset"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"none"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"outset"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thick"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thickThinLargeGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thickThinMediumGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thickThinSmallGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thinThickLargeGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thinThickMediumGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thinThickSmallGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thinThickThinLargeGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thinThickThinMediumGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thinThickThinSmallGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"threeDEmboss"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"threeDEngrave"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"triple"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wave"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/border/border.ts#L25">file/border/border.ts:25</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="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="IBorderOptions.html#color" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color?</span></a>
|
||
<a href="IBorderOptions.html#size" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size?</span></a>
|
||
<a href="IBorderOptions.html#space" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>space?</span></a>
|
||
<a href="IBorderOptions.html#style" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style</span></a>
|
||
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="color" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>color</span><a href="#color" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Border color, in hex (eg 'FF00AA')</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/border/border.ts#L28">file/border/border.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="size" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>size</span><a href="#size" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">size</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Size of the border in 1/8 pt</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/border/border.ts#L30">file/border/border.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="space" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>space</span><a href="#space" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">space</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Spacing offset. Values are specified in pt</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/border/border.ts#L32">file/border/border.ts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="style" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>style</span><a href="#style" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">style</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"nil"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"single"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dashDotStroked"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dashed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dashSmallGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dotDash"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dotDotDash"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dotted"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"double"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"doubleWave"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"inset"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"none"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"outset"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thick"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thickThinLargeGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thickThinMediumGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thickThinSmallGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thinThickLargeGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thinThickMediumGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thinThickSmallGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thinThickThinLargeGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thinThickThinMediumGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thinThickThinSmallGap"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"threeDEmboss"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"threeDEngrave"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"triple"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wave"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/f1359a4/src/file/border/border.ts#L26">file/border/border.ts:26</a></li></ul></aside></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="../assets/icons.svg#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="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#color" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color</span></a><a href="#size" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size</span></a><a href="#space" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>space</span></a><a href="#style" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style</span></a></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="../assets/icons.svg#icon-1"></use></svg><span>docx</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html> |