From d2b47e78e1ca17c18cdecee1aac56454db8d406d Mon Sep 17 00:00:00 2001
From: dolanmiu
Date: Fri, 8 Jul 2022 17:21:11 +0000
Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20dolanmiu?=
=?UTF-8?q?/docx@eb479c4684fac70e19b201350638ef5d68fb05a9=20=F0=9F=9A=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
_sidebar.md | 18 +--
api/classes/AbstractNumbering.html | 2 +-
api/classes/Bookmark.html | 6 +-
api/classes/ConcreteHyperlink.html | 2 +-
api/classes/ConcreteNumbering.html | 6 +-
api/classes/ExternalHyperlink.html | 2 +-
api/classes/Footer.html | 2 +-
api/classes/Header.html | 2 +-
api/classes/InternalHyperlink.html | 2 +-
api/classes/OutlineLevel.html | 2 +-
api/classes/StyleLevel.html | 4 +-
api/classes/TableBorders.html | 2 +-
api/classes/TableCell.html | 2 +-
api/enums/AlignmentType.html | 16 +--
api/enums/BorderStyle.html | 54 ++++----
api/enums/DocumentGridType.html | 8 +-
api/enums/DropCapType.html | 6 +-
api/enums/EmphasisMarkType.html | 2 +-
api/enums/FrameAnchorType.html | 6 +-
api/enums/FrameWrap.html | 12 +-
api/enums/HeaderFooterReferenceType.html | 6 +-
api/enums/HeaderFooterType.html | 4 +-
api/enums/HeadingLevel.html | 14 +-
api/enums/HeightRule.html | 6 +-
api/enums/HorizontalPositionAlign.html | 10 +-
api/enums/HorizontalPositionRelativeFrom.html | 16 +--
api/enums/HyperlinkType.html | 4 +-
api/enums/LeaderType.html | 10 +-
api/enums/LevelFormat.html | 28 ++--
api/enums/LevelSuffix.html | 6 +-
api/enums/LineNumberRestartFormat.html | 6 +-
api/enums/LineRuleType.html | 6 +-
api/enums/NumberFormat.html | 124 +++++++++---------
api/enums/OverlapType.html | 4 +-
api/enums/PageBorderDisplay.html | 6 +-
api/enums/PageBorderOffsetFrom.html | 4 +-
api/enums/PageBorderZOrder.html | 4 +-
api/enums/PageNumber.html | 6 +-
api/enums/PageNumberSeparator.html | 10 +-
api/enums/PageOrientation.html | 4 +-
api/enums/PageTextDirectionType.html | 4 +-
api/enums/PrettifyType.html | 8 +-
api/enums/RelativeHorizontalPosition.html | 10 +-
api/enums/RelativeVerticalPosition.html | 12 +-
api/enums/SectionType.html | 10 +-
api/enums/ShadingType.html | 74 +++++------
api/enums/SpaceType.html | 4 +-
api/enums/TabStopPosition.html | 2 +-
api/enums/TabStopType.html | 18 +--
api/enums/TableAnchorType.html | 6 +-
api/enums/TableLayoutType.html | 4 +-
api/enums/TextDirection.html | 6 +-
api/enums/TextWrappingSide.html | 8 +-
api/enums/TextWrappingType.html | 8 +-
api/enums/UnderlineType.html | 34 ++---
api/enums/VerticalAlign.html | 6 +-
api/enums/VerticalMergeType.html | 4 +-
api/enums/VerticalPositionAlign.html | 10 +-
api/enums/VerticalPositionRelativeFrom.html | 16 +--
api/enums/WidthType.html | 8 +-
api/interfaces/IAlignmentFrameOptions.html | 20 +--
.../IBaseCharacterStyleOptions.html | 18 +--
.../IBaseParagraphStyleOptions.html | 20 +--
api/interfaces/IBorderOptions.html | 8 +-
api/interfaces/IBordersOptions.html | 8 +-
api/interfaces/ICharacterStyleOptions.html | 20 +--
api/interfaces/IColumnAttributes.html | 4 +-
api/interfaces/IColumnsAttributes.html | 10 +-
api/interfaces/ICommentOptions.html | 10 +-
api/interfaces/ICommentsOptions.html | 2 +-
api/interfaces/IConcreteNumberingOptions.html | 10 +-
api/interfaces/IContext.html | 4 +-
api/interfaces/IDistance.html | 8 +-
.../IDocGridAttributesProperties.html | 6 +-
.../IDocumentAttributesProperties.html | 78 +++++------
.../IDocumentBackgroundOptions.html | 8 +-
api/interfaces/IDocumentDefaultsOptions.html | 4 +-
api/interfaces/IDocumentFooter.html | 4 +-
api/interfaces/IDocumentHeader.html | 4 +-
api/interfaces/IDocumentOptions.html | 2 +-
api/interfaces/IDocumentTemplate.html | 12 +-
api/interfaces/IDrawingOptions.html | 2 +-
api/interfaces/IFileProperties.html | 2 +-
api/interfaces/IFloating.html | 18 +--
api/interfaces/IFontAttributesProperties.html | 10 +-
api/interfaces/IHeaderFooterGroup.html | 6 +-
api/interfaces/IHeaderFooterOptions.html | 4 +-
api/interfaces/IHeaderOptions.html | 2 +-
.../IHorizontalPositionOptions.html | 6 +-
api/interfaces/IImageOptions.html | 6 +-
.../IIndentAttributesProperties.html | 12 +-
...ILevelParagraphStylePropertiesOptions.html | 20 +--
api/interfaces/ILevelsOptions.html | 14 +-
api/interfaces/ILineNumberAttributes.html | 8 +-
api/interfaces/IMargins.html | 8 +-
api/interfaces/IMathFractionOptions.html | 4 +-
api/interfaces/IMathFunctionOptions.html | 4 +-
api/interfaces/IMathOptions.html | 2 +-
.../IMathPreSubSuperScriptOptions.html | 6 +-
api/interfaces/IMathRadicalOptions.html | 4 +-
api/interfaces/IMathSubScriptOptions.html | 4 +-
.../IMathSubSuperScriptOptions.html | 6 +-
api/interfaces/IMathSumOptions.html | 6 +-
api/interfaces/IMathSuperScriptOptions.html | 4 +-
api/interfaces/IMediaData.html | 6 +-
api/interfaces/IMediaDataTransformation.html | 8 +-
api/interfaces/IMediaTransformation.html | 8 +-
api/interfaces/INumberingOptions.html | 2 +-
api/interfaces/IPageBorderAttributes.html | 6 +-
api/interfaces/IPageBordersOptions.html | 10 +-
api/interfaces/IPageMarginAttributes.html | 14 +-
api/interfaces/IPageNumberTypeAttributes.html | 6 +-
api/interfaces/IPageSizeAttributes.html | 6 +-
api/interfaces/IParagraphOptions.html | 48 +++----
.../IParagraphPropertiesOptions.html | 44 +++----
api/interfaces/IParagraphStyleOptions.html | 22 ++--
.../IParagraphStylePropertiesOptions.html | 22 ++--
api/interfaces/IRunOptions.html | 60 ++++-----
.../IRunPropertiesChangeOptions.html | 60 ++++-----
api/interfaces/IRunPropertiesOptions.html | 54 ++++----
.../IRunStylePropertiesOptions.html | 52 ++++----
api/interfaces/ISectionOptions.html | 8 +-
api/interfaces/ISectionPropertiesOptions.html | 18 +--
.../IShadingAttributesProperties.html | 6 +-
api/interfaces/ISpacingProperties.html | 12 +-
api/interfaces/IStylesOptions.html | 10 +-
api/interfaces/ISymbolRunOptions.html | 64 ++++-----
api/interfaces/ITableBordersOptions.html | 12 +-
api/interfaces/ITableCellBorders.html | 12 +-
api/interfaces/ITableCellOptions.html | 20 +--
api/interfaces/ITableFloatOptions.html | 22 ++--
api/interfaces/ITableOfContentsOptions.html | 32 ++---
api/interfaces/ITableOptions.html | 22 ++--
api/interfaces/ITablePropertiesOptions.html | 20 +--
api/interfaces/ITableRowOptions.html | 8 +-
.../ITableRowPropertiesOptions.html | 6 +-
api/interfaces/ITableWidthProperties.html | 4 +-
api/interfaces/ITextWrapping.html | 6 +-
api/interfaces/IVerticalPositionOptions.html | 6 +-
api/interfaces/IXYFrameOptions.html | 20 +--
api/interfaces/IXmlableObject.html | 2 +-
api/types/AttributeMap.html | 2 +-
api/types/IFrameOptions.html | 2 +-
api/types/MathComponent.html | 2 +-
api/types/ParagraphChild.html | 2 +-
api/variables/EMPTY_OBJECT.html | 2 +-
api/variables/sectionMarginDefaults.html | 2 +-
api/variables/sectionPageSizeDefaults.html | 2 +-
148 files changed, 928 insertions(+), 928 deletions(-)
diff --git a/_sidebar.md b/_sidebar.md
index feb12f2452..959b96aa94 100644
--- a/_sidebar.md
+++ b/_sidebar.md
@@ -9,21 +9,21 @@
- Usage
- [Document](usage/document.md)
- - [Sections](usage/sections.md)
+ - [Sections](usage/sections.md)
- [Paragraph](usage/paragraph.md)
- [Text](usage/text.md)
- [Image](usage/images.md)
- [Headers & Footers](usage/headers-and-footers.md)
- [Bullet Points](usage/bullet-points.md)
- - [Hyperlinks](usage/hyperlinks.md)
- - [Numbering](usage/numbering.md)
- - [Tables](usage/tables.md)
+ - [Hyperlinks](usage/hyperlinks.md)
+ - [Numbering](usage/numbering.md)
+ - [Tables](usage/tables.md)
- [Tab Stops](usage/tab-stops.md)
- - [Table of Contents](usage/table-of-contents.md)
- - [Page Numbers](usage/page-numbers.md)
- - [Change Tracking](usage/change-tracking.md)
- - [Math](usage/math.md)
- - [Text Frames](usage/text-frames.md)
+ - [Table of Contents](usage/table-of-contents.md)
+ - [Page Numbers](usage/page-numbers.md)
+ - [Change Tracking](usage/change-tracking.md)
+ - [Math](usage/math.md)
+ - [Text Frames](usage/text-frames.md)
- Styling
_ [Styling with JS](usage/styling-with-js.md)
_ [Styling with XML](usage/styling-with-xml.md)
diff --git a/api/classes/AbstractNumbering.html b/api/classes/AbstractNumbering.html
index e04a464f93..a76799b291 100644
--- a/api/classes/AbstractNumbering.html
+++ b/api/classes/AbstractNumbering.html
@@ -60,7 +60,7 @@
Readonly
id
id: number
+Defined in src/file/numbering/abstract-numbering.ts:33
Methods
diff --git a/api/classes/Bookmark.html b/api/classes/Bookmark.html
index 2aba99b1f7..b62c040708 100644
--- a/api/classes/Bookmark.html
+++ b/api/classes/Bookmark.html
@@ -57,17 +57,17 @@
Readonly
children
+Defined in src/file/paragraph/links/bookmark.ts:10
+Defined in src/file/paragraph/links/bookmark.ts:11
+Defined in src/file/paragraph/links/bookmark.ts:9
+Defined in src/file/paragraph/links/hyperlink.ts:42
+Defined in src/file/paragraph/formatting/alignment.ts:6
+Defined in src/file/paragraph/frame/frame-properties.ts:34
Optional
Readonly
anchor Lock
anchor Lock?: boolean
+Defined in src/file/paragraph/frame/frame-properties.ts:28
Optional
Readonly
drop Cap
+Defined in src/file/paragraph/frame/frame-properties.ts:29
Readonly
height
height: number
+Defined in src/file/paragraph/frame/frame-properties.ts:31
Optional
Readonly
lines
lines?: number
+Defined in src/file/paragraph/frame/frame-properties.ts:33
+Defined in src/file/paragraph/frame/frame-properties.ts:42
Optional
Readonly
space
space?: { horizontal: number ; vertical: number }
@@ -106,19 +106,19 @@
Readonly
vertical: number
+Defined in src/file/paragraph/frame/frame-properties.ts:38
Readonly
width
width: number
+Defined in src/file/paragraph/frame/frame-properties.ts:30
+Defined in src/file/paragraph/frame/frame-properties.ts:32
+Defined in src/file/numbering/num.ts:24
+Defined in src/file/numbering/level.ts:86
+Defined in src/file/media/data.ts:10
Readonly
pixels
pixels: { x: number ; y: number }
@@ -66,12 +66,12 @@
Readonly
y: number
+Defined in src/file/media/data.ts:2
Optional
Readonly
rotation
rotation?: number
+Defined in src/file/media/data.ts:14
+Defined in src/file/media/media.ts:6
+Defined in src/file/paragraph/properties.ts:31
Optional
Readonly
outline Level
outline Level?: number
+Defined in src/file/paragraph/properties.ts:27
Optional
Readonly
page Break Before
page Break Before?: boolean
+Defined in src/file/paragraph/properties.ts:43
Optional
Readonly
right Tab Stop
right Tab Stop?: number
+Defined in src/file/paragraph/properties.ts:21
Optional
Readonly
shading
+Defined in src/file/paragraph/properties.ts:53
Optional
Readonly
spacing
+Defined in src/file/paragraph/properties.ts:24
Optional
Readonly
style
style?: string
+Defined in src/file/paragraph/properties.ts:49
Optional
Readonly
suppress Line Numbers
suppress Line Numbers?: boolean
+Defined in src/file/paragraph/properties.ts:56
Optional
Readonly
tab Stops
+Defined in src/file/paragraph/properties.ts:44
Optional
Readonly
text
text?: string
+Defined in src/file/paragraph/paragraph.ts:38
Optional
Readonly
thematic Break
thematic Break?: boolean
+Defined in src/file/paragraph/properties.ts:19
Optional
Readonly
widow Control
widow Control?: boolean
+Defined in src/file/paragraph/properties.ts:54
+Defined in src/file/paragraph/properties.ts:31
Optional
Readonly
outline Level
outline Level?: number
+Defined in src/file/paragraph/properties.ts:27
Optional
Readonly
page Break Before
page Break Before?: boolean
+Defined in src/file/paragraph/properties.ts:43
Optional
Readonly
right Tab Stop
right Tab Stop?: number
+Defined in src/file/paragraph/properties.ts:21
Optional
Readonly
shading
+Defined in src/file/paragraph/properties.ts:53
Optional
Readonly
spacing
+Defined in src/file/paragraph/properties.ts:24
Optional
Readonly
style
style?: string
+Defined in src/file/paragraph/properties.ts:49
Optional
Readonly
suppress Line Numbers
suppress Line Numbers?: boolean
+Defined in src/file/paragraph/properties.ts:56
Optional
Readonly
tab Stops
+Defined in src/file/paragraph/properties.ts:44
Optional
Readonly
thematic Break
thematic Break?: boolean
+Defined in src/file/paragraph/properties.ts:19
Optional
Readonly
widow Control
widow Control?: boolean
+Defined in src/file/paragraph/properties.ts:54
+Defined in src/file/paragraph/properties.ts:19
+Defined in src/file/paragraph/run/properties.ts:23
+Defined in src/file/paragraph/run/properties.ts:23
+Defined in src/file/paragraph/run/properties.ts:23
+Defined in src/file/paragraph/run/properties.ts:23
+Defined in src/file/file.ts:25
Optional
Readonly
properties
+Defined in src/file/file.ts:35
+Defined in src/file/document/body/section-properties/section-properties.ts:40
+Defined in src/file/paragraph/run/properties.ts:23
+Defined in src/file/table/table-properties/table-float-properties.ts:80
Optional
Readonly
bottom From Text
bottom From Text?: string | number
@@ -67,7 +67,7 @@ If the attribute is omitted, the value is assumed to be zero.
below the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.
+Defined in src/file/table/table-properties/table-float-properties.ts:98
Optional
Readonly
horizontal Anchor
@@ -79,7 +79,7 @@ text - relative to the vertical edge of the text margin for the column in which
If omitted, the value is assumed to be page.
+Defined in src/file/table/table-properties/table-float-properties.ts:40
Optional
Readonly
left From Text
left From Text?: string | number
@@ -87,12 +87,12 @@ If omitted, the value is assumed to be page.
to the left of the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.
+Defined in src/file/table/table-properties/table-float-properties.ts:110
Optional
Readonly
overlap
+Defined in src/file/table/table-properties/table-float-properties.ts:117
Optional
Readonly
relative Horizontal Position
@@ -106,7 +106,7 @@ outside - the table should be outside of the anchor
right - the table should be right aligned with respect to the anchor
+Defined in src/file/table/table-properties/table-float-properties.ts:61
Optional
Readonly
relative Vertical Position
@@ -120,7 +120,7 @@ inline - the table should be vertically aligned in line with the surrounding tex
top - the table should be vertically aligned to the top edge of the anchor
+Defined in src/file/table/table-properties/table-float-properties.ts:92
Optional
Readonly
right From Text
right From Text?: string | number
@@ -128,7 +128,7 @@ top - the table should be vertically aligned to the top edge of the anchor
to the right of the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.
+Defined in src/file/table/table-properties/table-float-properties.ts:116
Optional
Readonly
top From Text
top From Text?: string | number
@@ -136,7 +136,7 @@ to the right of the table. The value is in twentieths of a point. If omitted, th
above the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.
+Defined in src/file/table/table-properties/table-float-properties.ts:104
Optional
Readonly
vertical Anchor
@@ -148,7 +148,7 @@ text - relative to the horizontal edge of the text margin for the column in whic
If omitted, the value is assumed to be page.
+Defined in src/file/table/table-properties/table-float-properties.ts:71
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:39
Optional
Readonly
entries From Bookmark
entries From Bookmark?: string
@@ -76,7 +76,7 @@ corresponding SEQ field.
the bookmark named by text in this switch's field-argument.
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:31
Optional
Readonly
entry And Page Number Separator
entry And Page Number Separator?: string
@@ -84,7 +84,7 @@ the bookmark named by text in this switch's field-argument.
that separate an entry and its page number. The default is a tab with leader dots.
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:86
Optional
Readonly
heading Style Range
heading Style Range?: string
@@ -95,21 +95,21 @@ to the style with a style ID of HeadingX (e.g. 1 corresponds to Heading1).
If no heading range is specified, all heading levels used in the document are listed.
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:80
Optional
Readonly
hide Tab And Page Numbers In Web View
hide Tab And Page Numbers In Web View?: boolean
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:121
Optional
Readonly
hyperlink
hyperlink?: boolean
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:56
Optional
Readonly
page Numbers Entry Levels Range
page Numbers Entry Levels Range?: string
@@ -118,21 +118,21 @@ Page numbers are omitted from all levels unless a range of entry levels is speci
text in this switch's field-argument. A range is specified as for \l.
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:71
Optional
Readonly
preserve New Line In Entries
preserve New Line In Entries?: boolean
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:116
Optional
Readonly
preserve Tab In Entries
preserve Tab In Entries?: boolean
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:111
Optional
Readonly
seq Field Identifier For Prefix
seq Field Identifier For Prefix?: string
@@ -141,7 +141,7 @@ The prefix depends on the type of entry. text in this switch's field-argumen
identifier in the SEQ field.
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:93
Optional
Readonly
sequence And Page Numbers Separator
sequence And Page Numbers Separator?: string
@@ -149,7 +149,7 @@ identifier in the SEQ field.
the separator between sequence and page numbers. The default separator is a hyphen (-).
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:45
Optional
Readonly
styles With Levels
@@ -159,7 +159,7 @@ with each doublet being a comma-separated set of style name and table of content
\t can be combined with \o.
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:101
Optional
Readonly
tc Field Identifier
tc Field Identifier?: string
@@ -167,7 +167,7 @@ with each doublet being a comma-separated set of style name and table of content
text in this switch's field-argument (which is typically a letter).
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:51
Optional
Readonly
tc Field Level Range
tc Field Level Range?: string
@@ -177,14 +177,14 @@ where startLevel and endLevel are integers, and startLevel has a value equal-to
TC fields that assign entries to lower levels are skipped.
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:64
Optional
Readonly
use Applied Paragraph Outline Level
use Applied Paragraph Outline Level?: boolean
+Defined in src/file/table-of-contents/table-of-contents-properties.ts:106
+Defined in src/file/table/table-row/table-row-properties.ts:36
+Defined in src/file/table/table-row/table-row-properties.ts:36
+Defined in src/file/paragraph/frame/frame-properties.ts:46
+Defined in src/file/paragraph/frame/frame-properties.ts:42
Optional
Readonly
space
space?: { horizontal: number ; vertical: number }
@@ -106,19 +106,19 @@
Readonly
vertical: number
+Defined in src/file/paragraph/frame/frame-properties.ts:38
Readonly
width
width: number
+Defined in src/file/paragraph/frame/frame-properties.ts:30
+Defined in src/file/paragraph/frame/frame-properties.ts:32
+Defined in src/file/paragraph/frame/frame-properties.ts:61
+Defined in src/file/paragraph/math/math-component.ts:9
+Defined in src/file/paragraph/paragraph.ts:15
+Defined in src/file/xml-components/xml-component.ts:4
+Defined in src/file/document/body/section-properties/section-properties.ts:78
+Defined in src/file/document/body/section-properties/section-properties.ts:88
At least the value specified