2024-10-10 23:31:27 +00:00
|
|
|
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ISymbolRunOptions | 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="ISymbolRunOptions.html">ISymbolRunOptions</a></li></ul><h1>Interface ISymbolRunOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ISymbolRunOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="ISymbolRunOptions.html#allCaps">allCaps</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ISymbolRunOptions.html#bold">bold</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ISymbolRunOptions.html#boldComplexScript">boldComplexScript</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ISymbolRunOptions.html#border">border</a><span class="tsd-signature-symbol">?: </span><a href="IBorderOptions.html" class="tsd-signature-type tsd-kind-interface">IBorderOptions</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ISymbolRunOptions.html#break">break</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="ISymbolRunOptions.html#char">char</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="ISymbolRunOptions.html#characterSpacing">characterSpacing</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="
|
2024-10-09 20:29:20 +00:00
|
|
|
|
<a href="ISymbolRunOptions.html#bold" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bold?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#boldComplexScript" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bold<wbr/>Complex<wbr/>Script?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#border" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>border?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#break" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>break?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#char" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>char</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#characterSpacing" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>character<wbr/>Spacing?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#children" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>children?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#color" class="tsd-index-link tsd-is-inherited"><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="ISymbolRunOptions.html#doubleStrike" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>double<wbr/>Strike?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#effect" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>effect?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#emboss" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emboss?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#emphasisMark" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emphasis<wbr/>Mark?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#font" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>font?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#highlight" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>highlight?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#highlightComplexScript" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>highlight<wbr/>Complex<wbr/>Script?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#imprint" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>imprint?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#italics" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>italics?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#italicsComplexScript" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>italics<wbr/>Complex<wbr/>Script?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#kern" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>kern?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#language" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>language?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#math" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>math?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#noProof" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>no<wbr/>Proof?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#position" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#revision" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>revision?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#rightToLeft" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>right<wbr/>To<wbr/>Left?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#scale" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scale?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#shading" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shading?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#size" class="tsd-index-link tsd-is-inherited"><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="ISymbolRunOptions.html#sizeComplexScript" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size<wbr/>Complex<wbr/>Script?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#smallCaps" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>small<wbr/>Caps?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#snapToGrid" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>snap<wbr/>To<wbr/>Grid?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#specVanish" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spec<wbr/>Vanish?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#strike" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>strike?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#style" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#subScript" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sub<wbr/>Script?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#superScript" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>super<wbr/>Script?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#symbolfont" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>symbolfont?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#text" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#underline" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>underline?</span></a>
|
|
|
|
|
|
<a href="ISymbolRunOptions.html#vanish" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vanish?</span></a>
|
2024-10-10 23:31:27 +00:00
|
|
|
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="allCaps" 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>all<wbr/>Caps</span><a href="#allCaps" 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">all<wbr/>Caps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IRunOptions.html">IRunOptions</a>.<a href="IRunOptions.html#allCaps">allCaps</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ae7492/src/file/paragraph/run/properties.ts#L89">file/paragraph/run/properties.ts:89</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="bold" 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>bold</span><a href="#bold" 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">bold</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IRunOptions.html">IRunOptions</a>.<a href="IRunOptions.html#bold">bold</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ae7492/src/file/paragraph/run/properties.ts#L70">file/paragraph/run/properties.ts:70</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="boldComplexScript" 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>bold<wbr/>Complex<wbr/>Script</span><a href="#boldComplexScript" 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">bold<wbr/>Complex<wbr/>Script</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IRunOptions.html">IRunOptions</a>.<a href="IRunOptions.html#boldComplexScript">boldComplexScript</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ae7492/src/file/paragraph/run/properties.ts#L71">file/paragraph/run/properties.ts:71</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="border" 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>border</span><a href="#border" 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">border</span><span class="tsd-signature-symbol">?:</span> <a href="IBorderOptions.html" class="tsd-signature-type tsd-kind-interface">IBorderOptions</a></div><aside class="tsd-sources"><p>Inherited from <a href="IRunOptions.html">IRunOptions</a>.<a href="IRunOptions.html#border">border</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/3ae7492/src/file/paragraph/run/properties.ts#L103">file/paragraph/run/properties.ts:103</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="break" 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>break</span><a href="#break
|
