smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ dolanmiu/docx@c3080ff9d9 🚀

Browse Source
This commit is contained in:
dolanmiu
2023-12-25 02:48:48 +00:00
parent b88b99f159
commit c4f13c5218
371 changed files with 3626 additions and 2931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
api/interfaces/IParagraphStyleOptions.html
View File

@ -22,7 +22,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">IParagraphStyleOptions</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/styles/style/paragraph-style.ts#L10">file/styles/style/paragraph-style.ts:10</a></li></ul></aside>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/styles/style/paragraph-style.ts#L10">file/styles/style/paragraph-style.ts:10</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">
@ -55,66 +55,66 @@ However, if the current style is a numbering style, then the <code>basedOn</code
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="IBaseParagraphStyleOptions.html">IBaseParagraphStyleOptions</a>.<a href="IBaseParagraphStyleOptions.html#basedOn">basedOn</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/styles/style/style.ts#L51">file/styles/style/style.ts:51</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/styles/style/style.ts#L51">file/styles/style/style.ts:51</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/styles/style/paragraph-style.ts#L11">file/styles/style/paragraph-style.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/styles/style/paragraph-style.ts#L11">file/styles/style/paragraph-style.ts:11</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="link" 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>link</span><a href="#link" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">link</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Inherited from <a href="IBaseParagraphStyleOptions.html">IBaseParagraphStyleOptions</a>.<a href="IBaseParagraphStyleOptions.html#link">link</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/styles/style/style.ts#L53">file/styles/style/style.ts:53</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/styles/style/style.ts#L53">file/styles/style/style.ts:53</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="name" 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>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Inherited from <a href="IBaseParagraphStyleOptions.html">IBaseParagraphStyleOptions</a>.<a href="IBaseParagraphStyleOptions.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/styles/style/style.ts#L43">file/styles/style/style.ts:43</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/styles/style/style.ts#L43">file/styles/style/style.ts:43</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="next" 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>next</span><a href="#next" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Inherited from <a href="IBaseParagraphStyleOptions.html">IBaseParagraphStyleOptions</a>.<a href="IBaseParagraphStyleOptions.html#next">next</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/styles/style/style.ts#L52">file/styles/style/style.ts:52</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/styles/style/style.ts#L52">file/styles/style/style.ts:52</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="paragraph" 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>paragraph</span><a href="#paragraph" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">paragraph</span><span class="tsd-signature-symbol">?:</span> <a href="IParagraphStylePropertiesOptions.html" class="tsd-signature-type tsd-kind-interface">IParagraphStylePropertiesOptions</a></div><aside class="tsd-sources">
<p>Inherited from <a href="IBaseParagraphStyleOptions.html">IBaseParagraphStyleOptions</a>.<a href="IBaseParagraphStyleOptions.html#paragraph">paragraph</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/styles/style/paragraph-style.ts#L6">file/styles/style/paragraph-style.ts:6</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/styles/style/paragraph-style.ts#L6">file/styles/style/paragraph-style.ts:6</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="quickFormat" 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>quick<wbr/>Format</span><a href="#quickFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">quick<wbr/>Format</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<p>Inherited from <a href="IBaseParagraphStyleOptions.html">IBaseParagraphStyleOptions</a>.<a href="IBaseParagraphStyleOptions.html#quickFormat">quickFormat</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/styles/style/style.ts#L57">file/styles/style/style.ts:57</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/styles/style/style.ts#L57">file/styles/style/style.ts:57</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="run" 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>run</span><a href="#run" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">run</span><span class="tsd-signature-symbol">?:</span> <a href="IRunStylePropertiesOptions.html" class="tsd-signature-type tsd-kind-interface">IRunStylePropertiesOptions</a></div><aside class="tsd-sources">
<p>Inherited from <a href="IBaseParagraphStyleOptions.html">IBaseParagraphStyleOptions</a>.<a href="IBaseParagraphStyleOptions.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/styles/style/paragraph-style.ts#L7">file/styles/style/paragraph-style.ts:7</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/styles/style/paragraph-style.ts#L7">file/styles/style/paragraph-style.ts:7</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="semiHidden" 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>semi<wbr/>Hidden</span><a href="#semiHidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">semi<wbr/>Hidden</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<p>Inherited from <a href="IBaseParagraphStyleOptions.html">IBaseParagraphStyleOptions</a>.<a href="IBaseParagraphStyleOptions.html#semiHidden">semiHidden</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/styles/style/style.ts#L55">file/styles/style/style.ts:55</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/styles/style/style.ts#L55">file/styles/style/style.ts:55</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="uiPriority" 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>ui<wbr/>Priority</span><a href="#uiPriority" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">ui<wbr/>Priority</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<p>Inherited from <a href="IBaseParagraphStyleOptions.html">IBaseParagraphStyleOptions</a>.<a href="IBaseParagraphStyleOptions.html#uiPriority">uiPriority</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/styles/style/style.ts#L54">file/styles/style/style.ts:54</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/styles/style/style.ts#L54">file/styles/style/style.ts:54</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="unhideWhenUsed" 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>unhide<wbr/>When<wbr/>Used</span><a href="#unhideWhenUsed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">unhide<wbr/>When<wbr/>Used</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<p>Inherited from <a href="IBaseParagraphStyleOptions.html">IBaseParagraphStyleOptions</a>.<a href="IBaseParagraphStyleOptions.html#unhideWhenUsed">unhideWhenUsed</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/772fc84/src/file/styles/style/style.ts#L56">file/styles/style/style.ts:56</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/c3080ff/src/file/styles/style/style.ts#L56">file/styles/style/style.ts:56</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@ -220,7 +220,6 @@ However, if the current style is a numbering style, then the <code>basedOn</code
<li><a href="../classes/LevelBase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Level<wbr/>Base</span></a></li>
<li><a href="../classes/LevelForOverride.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Level<wbr/>For<wbr/>Override</span></a></li>
<li><a href="../classes/LevelOverride.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Level<wbr/>Override</span></a></li>
<li><a href="../classes/LineNumberType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Line<wbr/>Number<wbr/>Type</span></a></li>
<li><a href="../classes/Math.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Math</span></a></li>
<li><a href="../classes/MathAccentCharacter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Math<wbr/>Accent<wbr/>Character</span></a></li>
<li><a href="../classes/MathAngledBrackets.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Math<wbr/>Angled<wbr/>Brackets</span></a></li>
@ -366,7 +365,6 @@ However, if the current style is a numbering style, then the <code>basedOn</code
<li><a href="IIndentAttributesProperties.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IIndent<wbr/>Attributes<wbr/>Properties</span></a></li>
<li><a href="ILevelParagraphStylePropertiesOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ILevel<wbr/>Paragraph<wbr/>Style<wbr/>Properties<wbr/>Options</span></a></li>
<li><a href="ILevelsOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ILevels<wbr/>Options</span></a></li>
<li><a href="ILineNumberAttributes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ILine<wbr/>Number<wbr/>Attributes</span></a></li>
<li><a href="IMargins.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IMargins</span></a></li>
<li><a href="IMathFractionOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IMath<wbr/>Fraction<wbr/>Options</span></a></li>
<li><a href="IMathFunctionOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IMath<wbr/>Function<wbr/>Options</span></a></li>
@ -420,7 +418,9 @@ However, if the current style is a numbering style, then the <code>basedOn</code
<li><a href="../types/AttributePayload.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Attribute<wbr/>Payload</span></a></li>
<li><a href="../types/IColumnsAttributes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IColumns<wbr/>Attributes</span></a></li>
<li><a href="../types/IFrameOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IFrame<wbr/>Options</span></a></li>
<li><a href="../types/ILineNumberAttributes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>ILine<wbr/>Number<wbr/>Attributes</span></a></li>
<li><a href="../types/IPageMarginAttributes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IPage<wbr/>Margin<wbr/>Attributes</span></a></li>
<li><a href="../types/IPageReferenceOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IPage<wbr/>Reference<wbr/>Options</span></a></li>
<li><a href="../types/IPageSizeAttributes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IPage<wbr/>Size<wbr/>Attributes</span></a></li>
<li><a href="../types/IPatch.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IPatch</span></a></li>
<li><a href="../types/ITableFloatOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>ITable<wbr/>Float<wbr/>Options</span></a></li>
@ -492,6 +492,7 @@ However, if the current style is a numbering style, then the <code>basedOn</code
<li><a href="../functions/convertInchesToTwip.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>Inches<wbr/>To<wbr/>Twip</span></a></li>
<li><a href="../functions/convertMillimetersToTwip.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>Millimeters<wbr/>To<wbr/>Twip</span></a></li>
<li><a href="../functions/convertToXmlComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>To<wbr/>Xml<wbr/>Component</span></a></li>
<li><a href="../functions/createLineNumberType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Line<wbr/>Number<wbr/>Type</span></a></li>
<li><a href="../functions/dateTimeValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>date<wbr/>Time<wbr/>Value</span></a></li>
<li><a href="../functions/decimalNumber.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>decimal<wbr/>Number</span></a></li>
<li><a href="../functions/docPropertiesUniqueNumericIdGen.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>doc<wbr/>Properties<wbr/>Unique<wbr/>Numeric<wbr/>Id<wbr/>Gen</span></a></li>