From 31f054012c326cf519036e6acba54ebd960f12cf Mon Sep 17 00:00:00 2001 From: dolanmiu Date: Tue, 19 Jul 2022 00:56:37 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20dolanmiu?= =?UTF-8?q?/docx@ebf06250b1704fa472999187262be54f6ac79caa=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api/assets/style.css | 2 +- api/classes/AbstractNumbering.html | 18 ++- api/classes/Alignment.html | 16 ++- api/classes/AlignmentAttributes.html | 12 +- api/classes/Attributes.html | 12 +- api/classes/BaseEmphasisMark.html | 12 +- api/classes/BaseXmlComponent.html | 12 +- api/classes/Body.html | 24 +++- api/classes/Bookmark.html | 14 +- api/classes/BookmarkEnd.html | 16 ++- api/classes/BookmarkStart.html | 16 ++- api/classes/Border.html | 16 ++- api/classes/BorderElement.html | 16 ++- api/classes/Column.html | 16 ++- api/classes/ColumnAttributes.html | 12 +- api/classes/ColumnBreak.html | 16 ++- api/classes/Columns.html | 16 ++- api/classes/ColumnsAttributes.html | 12 +- api/classes/Comment.html | 16 ++- api/classes/CommentRangeEnd.html | 16 ++- api/classes/CommentRangeStart.html | 16 ++- api/classes/CommentReference.html | 16 ++- api/classes/Comments.html | 16 ++- api/classes/ConcreteHyperlink.html | 18 ++- api/classes/ConcreteNumbering.html | 22 ++- api/classes/DeletedTextRun.html | 16 ++- api/classes/DocGridAttributes.html | 12 +- api/classes/Document.html | 64 ++++++--- api/classes/DocumentAttributes.html | 12 +- api/classes/DocumentBackground.html | 16 ++- api/classes/DocumentBackgroundAttributes.html | 12 +- api/classes/DocumentDefaults.html | 16 ++- api/classes/DocumentGrid.html | 16 ++- api/classes/DotEmphasisMark.html | 16 ++- api/classes/Drawing.html | 16 ++- api/classes/EmphasisMark.html | 16 ++- api/classes/ExternalHyperlink.html | 10 +- .../FootNoteReferenceRunAttributes.html | 12 +- api/classes/FootNotes.html | 20 ++- api/classes/Footer.html | 10 +- api/classes/FooterWrapper.html | 28 +++- api/classes/FootnoteReference.html | 16 ++- api/classes/FootnoteReferenceRun.html | 16 ++- api/classes/FrameProperties.html | 16 ++- api/classes/FramePropertiesAttributes.html | 12 +- api/classes/GridSpan.html | 16 ++- api/classes/Header.html | 10 +- api/classes/HeaderFooterReference.html | 16 ++- api/classes/HeaderWrapper.html | 28 +++- api/classes/HorizontalPosition.html | 16 ++- api/classes/HpsMeasureElement.html | 16 ++- api/classes/IgnoreIfEmptyXmlComponent.html | 16 ++- api/classes/ImageRun.html | 16 ++- api/classes/ImportDotx.html | 8 +- .../ImportedRootElementAttributes.html | 16 ++- api/classes/ImportedXmlComponent.html | 24 +++- api/classes/Indent.html | 16 ++- api/classes/InitializableXmlComponent.html | 16 ++- api/classes/InsertedTextRun.html | 16 ++- api/classes/InternalHyperlink.html | 18 ++- api/classes/Level.html | 16 ++- api/classes/LevelBase.html | 16 ++- api/classes/LevelForOverride.html | 16 ++- api/classes/LevelOverride.html | 16 ++- api/classes/LineNumberAttributes.html | 12 +- api/classes/LineNumberType.html | 16 ++- api/classes/Math.html | 16 ++- api/classes/MathAccentCharacter.html | 16 ++- api/classes/MathAngledBrackets.html | 16 ++- api/classes/MathBase.html | 16 ++- api/classes/MathCurlyBrackets.html | 16 ++- api/classes/MathDegree.html | 16 ++- api/classes/MathDenominator.html | 16 ++- api/classes/MathFraction.html | 16 ++- api/classes/MathFunction.html | 16 ++- api/classes/MathFunctionName.html | 16 ++- api/classes/MathFunctionProperties.html | 16 ++- api/classes/MathLimitLocation.html | 16 ++- api/classes/MathNAryProperties.html | 16 ++- api/classes/MathNumerator.html | 16 ++- api/classes/MathPreSubSuperScript.html | 16 ++- .../MathPreSubSuperScriptProperties.html | 16 ++- api/classes/MathRadical.html | 16 ++- api/classes/MathRadicalProperties.html | 16 ++- api/classes/MathRoundBrackets.html | 16 ++- api/classes/MathRun.html | 16 ++- api/classes/MathSquareBrackets.html | 16 ++- api/classes/MathSubScript.html | 16 ++- api/classes/MathSubScriptElement.html | 16 ++- api/classes/MathSubScriptProperties.html | 16 ++- api/classes/MathSubSuperScript.html | 16 ++- api/classes/MathSubSuperScriptProperties.html | 16 ++- api/classes/MathSum.html | 16 ++- api/classes/MathSuperScript.html | 16 ++- api/classes/MathSuperScriptElement.html | 16 ++- api/classes/MathSuperScriptProperties.html | 16 ++- api/classes/Media.html | 20 ++- api/classes/NumberProperties.html | 16 ++- api/classes/NumberValueElement.html | 16 ++- api/classes/Numbering.html | 28 +++- api/classes/OnOffElement.html | 16 ++- api/classes/OutlineLevel.html | 18 ++- api/classes/Packer.html | 16 ++- api/classes/PageBorders.html | 16 ++- api/classes/PageBreak.html | 16 ++- api/classes/PageBreakBefore.html | 16 ++- api/classes/PageMargin.html | 16 ++- api/classes/PageMarginAttributes.html | 12 +- api/classes/PageNumberType.html | 16 ++- api/classes/PageNumberTypeAttributes.html | 12 +- api/classes/PageReference.html | 16 ++- api/classes/PageSize.html | 16 ++- api/classes/PageSizeAttributes.html | 12 +- api/classes/PageTextDirection.html | 16 ++- api/classes/Paragraph.html | 20 ++- api/classes/ParagraphProperties.html | 20 ++- api/classes/ParagraphPropertiesDefaults.html | 16 ++- api/classes/Run.html | 16 ++- api/classes/RunFonts.html | 20 ++- api/classes/RunProperties.html | 20 ++- api/classes/RunPropertiesChange.html | 16 ++- api/classes/RunPropertiesDefaults.html | 16 ++- api/classes/SectionProperties.html | 16 ++- api/classes/SectionTypeAttributes.html | 12 +- api/classes/SequentialIdentifier.html | 16 ++- api/classes/Shading.html | 16 ++- api/classes/SimpleField.html | 16 ++- api/classes/SimpleMailMergeField.html | 16 ++- api/classes/SimplePos.html | 16 ++- api/classes/Spacing.html | 16 ++- api/classes/StringContainer.html | 16 ++- api/classes/StringValueElement.html | 16 ++- api/classes/Style.html | 16 ++- api/classes/StyleForCharacter.html | 16 ++- api/classes/StyleForParagraph.html | 16 ++- api/classes/StyleLevel.html | 12 +- api/classes/Styles.html | 16 ++- api/classes/SymbolRun.html | 16 ++- api/classes/TDirection.html | 16 ++- api/classes/Tab.html | 16 ++- api/classes/TabAttributes.html | 12 +- api/classes/TabStop.html | 16 ++- api/classes/TabStopItem.html | 16 ++- api/classes/Table.html | 16 ++- api/classes/TableBorders.html | 18 ++- api/classes/TableCell.html | 18 ++- api/classes/TableCellBorders.html | 16 ++- api/classes/TableFloatOptionsAttributes.html | 12 +- api/classes/TableFloatProperties.html | 16 ++- api/classes/TableLayout.html | 16 ++- api/classes/TableOfContents.html | 16 ++- api/classes/TableOverlap.html | 16 ++- api/classes/TableProperties.html | 16 ++- api/classes/TableRow.html | 40 ++++-- api/classes/TableRowHeight.html | 16 ++- api/classes/TableRowHeightAttributes.html | 12 +- api/classes/TableRowProperties.html | 16 ++- api/classes/TableWidthElement.html | 16 ++- api/classes/TextRun.html | 16 ++- api/classes/ThematicBreak.html | 16 ++- api/classes/Type.html | 16 ++- api/classes/Underline.html | 16 ++- api/classes/VerticalAlignAttributes.html | 12 +- api/classes/VerticalAlignElement.html | 16 ++- api/classes/VerticalMerge.html | 16 ++- api/classes/VerticalPosition.html | 16 ++- api/classes/WrapNone.html | 16 ++- api/classes/WrapSquare.html | 16 ++- api/classes/WrapTight.html | 16 ++- api/classes/WrapTopAndBottom.html | 16 ++- api/classes/XmlAttributeComponent.html | 12 +- api/classes/XmlComponent.html | 16 ++- api/enums/AlignmentType.html | 20 +-- api/enums/BorderStyle.html | 58 ++++---- api/enums/DocumentGridType.html | 12 +- api/enums/DropCapType.html | 10 +- api/enums/EmphasisMarkType.html | 6 +- api/enums/FrameAnchorType.html | 10 +- api/enums/FrameWrap.html | 16 ++- api/enums/HeaderFooterReferenceType.html | 10 +- api/enums/HeaderFooterType.html | 8 +- api/enums/HeadingLevel.html | 18 +-- api/enums/HeightRule.html | 10 +- api/enums/HorizontalPositionAlign.html | 14 +- api/enums/HorizontalPositionRelativeFrom.html | 20 +-- api/enums/HyperlinkType.html | 8 +- api/enums/LeaderType.html | 14 +- api/enums/LevelFormat.html | 32 +++-- api/enums/LevelSuffix.html | 10 +- api/enums/LineNumberRestartFormat.html | 10 +- api/enums/LineRuleType.html | 10 +- api/enums/NumberFormat.html | 128 +++++++++--------- api/enums/OverlapType.html | 8 +- api/enums/PageBorderDisplay.html | 10 +- api/enums/PageBorderOffsetFrom.html | 8 +- api/enums/PageBorderZOrder.html | 8 +- api/enums/PageNumber.html | 10 +- api/enums/PageNumberSeparator.html | 14 +- api/enums/PageOrientation.html | 8 +- api/enums/PageTextDirectionType.html | 8 +- api/enums/PrettifyType.html | 12 +- api/enums/RelativeHorizontalPosition.html | 14 +- api/enums/RelativeVerticalPosition.html | 16 ++- api/enums/SectionType.html | 14 +- api/enums/ShadingType.html | 78 +++++------ api/enums/SpaceType.html | 8 +- api/enums/TabStopPosition.html | 6 +- api/enums/TabStopType.html | 22 +-- api/enums/TableAnchorType.html | 10 +- api/enums/TableLayoutType.html | 8 +- api/enums/TextDirection.html | 10 +- api/enums/TextWrappingSide.html | 12 +- api/enums/TextWrappingType.html | 12 +- api/enums/UnderlineType.html | 38 +++--- api/enums/VerticalAlign.html | 10 +- api/enums/VerticalMergeType.html | 8 +- api/enums/VerticalPositionAlign.html | 14 +- api/enums/VerticalPositionRelativeFrom.html | 20 +-- api/enums/WidthType.html | 12 +- api/functions/convertInchesToTwip.html | 4 +- api/functions/convertMillimetersToTwip.html | 4 +- api/functions/convertToXmlComponent.html | 4 +- api/functions/dateTimeValue.html | 4 +- api/functions/decimalNumber.html | 4 +- api/functions/eighthPointMeasureValue.html | 4 +- api/functions/hexColorValue.html | 4 +- api/functions/hpsMeasureValue.html | 4 +- api/functions/longHexNumber.html | 4 +- api/functions/measurementOrPercentValue.html | 4 +- api/functions/percentageValue.html | 4 +- api/functions/pointMeasureValue.html | 4 +- .../positiveUniversalMeasureValue.html | 4 +- api/functions/shortHexNumber.html | 4 +- api/functions/signedHpsMeasureValue.html | 4 +- api/functions/signedTwipsMeasureValue.html | 4 +- api/functions/twipsMeasureValue.html | 4 +- api/functions/uCharHexNumber.html | 4 +- api/functions/uniqueId.html | 4 +- api/functions/uniqueNumericId.html | 4 +- api/functions/universalMeasureValue.html | 4 +- api/functions/unsignedDecimalNumber.html | 4 +- api/interfaces/IAlignmentFrameOptions.html | 24 ++-- .../IBaseCharacterStyleOptions.html | 22 +-- .../IBaseParagraphStyleOptions.html | 24 ++-- api/interfaces/IBorderOptions.html | 12 +- api/interfaces/IBordersOptions.html | 12 +- api/interfaces/ICharacterStyleOptions.html | 24 ++-- api/interfaces/IColumnAttributes.html | 8 +- api/interfaces/IColumnsAttributes.html | 14 +- api/interfaces/ICommentOptions.html | 14 +- api/interfaces/ICommentsOptions.html | 6 +- api/interfaces/IConcreteNumberingOptions.html | 14 +- api/interfaces/IContext.html | 8 +- api/interfaces/IDistance.html | 12 +- .../IDocGridAttributesProperties.html | 10 +- .../IDocumentAttributesProperties.html | 82 +++++------ .../IDocumentBackgroundOptions.html | 12 +- api/interfaces/IDocumentDefaultsOptions.html | 8 +- api/interfaces/IDocumentFooter.html | 8 +- api/interfaces/IDocumentHeader.html | 8 +- api/interfaces/IDocumentOptions.html | 6 +- api/interfaces/IDocumentTemplate.html | 16 ++- api/interfaces/IDrawingOptions.html | 6 +- api/interfaces/IFileProperties.html | 6 +- api/interfaces/IFloating.html | 22 +-- api/interfaces/IFontAttributesProperties.html | 14 +- api/interfaces/IHeaderFooterGroup.html | 10 +- api/interfaces/IHeaderFooterOptions.html | 8 +- api/interfaces/IHeaderOptions.html | 6 +- .../IHorizontalPositionOptions.html | 10 +- api/interfaces/IImageOptions.html | 10 +- .../IIndentAttributesProperties.html | 16 ++- ...ILevelParagraphStylePropertiesOptions.html | 24 ++-- api/interfaces/ILevelsOptions.html | 18 +-- api/interfaces/ILineNumberAttributes.html | 12 +- api/interfaces/IMargins.html | 12 +- api/interfaces/IMathFractionOptions.html | 8 +- api/interfaces/IMathFunctionOptions.html | 8 +- api/interfaces/IMathOptions.html | 6 +- .../IMathPreSubSuperScriptOptions.html | 10 +- api/interfaces/IMathRadicalOptions.html | 8 +- api/interfaces/IMathSubScriptOptions.html | 8 +- .../IMathSubSuperScriptOptions.html | 10 +- api/interfaces/IMathSumOptions.html | 10 +- api/interfaces/IMathSuperScriptOptions.html | 8 +- api/interfaces/IMediaData.html | 10 +- api/interfaces/IMediaDataTransformation.html | 12 +- api/interfaces/IMediaTransformation.html | 12 +- api/interfaces/INumberingOptions.html | 6 +- api/interfaces/IPageBorderAttributes.html | 10 +- api/interfaces/IPageBordersOptions.html | 14 +- api/interfaces/IPageMarginAttributes.html | 18 +-- api/interfaces/IPageNumberTypeAttributes.html | 10 +- api/interfaces/IPageSizeAttributes.html | 10 +- api/interfaces/IParagraphOptions.html | 52 +++---- .../IParagraphPropertiesOptions.html | 48 +++---- api/interfaces/IParagraphStyleOptions.html | 26 ++-- .../IParagraphStylePropertiesOptions.html | 26 ++-- api/interfaces/IRunOptions.html | 64 ++++----- .../IRunPropertiesChangeOptions.html | 64 ++++----- api/interfaces/IRunPropertiesOptions.html | 58 ++++---- .../IRunStylePropertiesOptions.html | 56 ++++---- api/interfaces/ISectionOptions.html | 12 +- api/interfaces/ISectionPropertiesOptions.html | 22 +-- .../IShadingAttributesProperties.html | 10 +- api/interfaces/ISpacingProperties.html | 16 ++- api/interfaces/IStylesOptions.html | 14 +- api/interfaces/ISymbolRunOptions.html | 68 +++++----- api/interfaces/ITableBordersOptions.html | 16 ++- api/interfaces/ITableCellBorders.html | 16 ++- api/interfaces/ITableCellOptions.html | 24 ++-- api/interfaces/ITableFloatOptions.html | 26 ++-- api/interfaces/ITableOfContentsOptions.html | 36 ++--- api/interfaces/ITableOptions.html | 26 ++-- api/interfaces/ITablePropertiesOptions.html | 24 ++-- api/interfaces/ITableRowOptions.html | 12 +- .../ITableRowPropertiesOptions.html | 10 +- api/interfaces/ITableWidthProperties.html | 8 +- api/interfaces/ITextWrapping.html | 10 +- api/interfaces/IVerticalPositionOptions.html | 10 +- api/interfaces/IXYFrameOptions.html | 24 ++-- api/interfaces/IXmlAttribute.html | 4 +- api/interfaces/IXmlableObject.html | 30 ++-- 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 +- 330 files changed, 3455 insertions(+), 1765 deletions(-) diff --git a/api/assets/style.css b/api/assets/style.css index 048427e083..8f6ed2c437 100644 --- a/api/assets/style.css +++ b/api/assets/style.css @@ -942,7 +942,7 @@ a.tsd-index-link { margin: 2rem 0; } .tsd-panel-group.tsd-index-group details { - margin: 4rem 0; + margin: 2rem 0; } #tsd-search { diff --git a/api/classes/AbstractNumbering.html b/api/classes/AbstractNumbering.html index 7a64511cb3..8b704d1f01 100644 --- a/api/classes/AbstractNumbering.html +++ b/api/classes/AbstractNumbering.html @@ -18,7 +18,9 @@ +
  • AbstractNumbering
    • @@ -52,14 +54,16 @@
  • levelOptions: ILevelsOptions[]

    • Returns AbstractNumbering

    +

    Overrides XmlComponent.constructor

    +

    Properties

    Readonly id

    id: number
    +
  • Defined in src/file/numbering/abstract-numbering.ts:33

    • Methods

    @@ -73,7 +77,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Alignment.html b/api/classes/Alignment.html index 8758c2213b..4e7907c90f 100644 --- a/api/classes/Alignment.html +++ b/api/classes/Alignment.html @@ -18,7 +18,9 @@ +
  • Alignment
    • @@ -46,7 +48,9 @@
  • type: AlignmentType

    • Returns Alignment

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/AlignmentAttributes.html b/api/classes/AlignmentAttributes.html index 0cf1f49b35..c87380152c 100644 --- a/api/classes/AlignmentAttributes.html +++ b/api/classes/AlignmentAttributes.html @@ -18,7 +18,9 @@ +
  • AlignmentAttributes
    • @@ -48,7 +50,9 @@
  • Readonly val: AlignmentType

    • Returns AlignmentAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/Attributes.html b/api/classes/Attributes.html index 6fb7ee75f6..c2d1f96a59 100644 --- a/api/classes/Attributes.html +++ b/api/classes/Attributes.html @@ -18,7 +18,9 @@
    • XmlAttributeComponent<{ bottom?: string; color?: string; fill?: string; footer?: string; gutter?: string; h?: string; header?: string; left?: string; linePitch?: string; pos?: string | number; right?: string; rsidR?: string; rsidRPr?: string; rsidSect?: string; space?: string; sz?: string; top?: string; type?: string; val?: string | number | boolean; w?: string }>
        -
      • Attributes
    +
  • Attributes
    • @@ -86,7 +88,9 @@
  • Optional Readonly w?: string

    • Returns Attributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -100,7 +104,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/BaseEmphasisMark.html b/api/classes/BaseEmphasisMark.html index b3fc20ca9d..f7cd9471bb 100644 --- a/api/classes/BaseEmphasisMark.html +++ b/api/classes/BaseEmphasisMark.html @@ -21,7 +21,9 @@
  • BaseEmphasisMark
    • +
  • DotEmphasisMark
    • @@ -45,7 +47,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/BaseXmlComponent.html b/api/classes/BaseXmlComponent.html index 07b3eff0c8..75740be569 100644 --- a/api/classes/BaseXmlComponent.html +++ b/api/classes/BaseXmlComponent.html @@ -19,7 +19,9 @@
  • BaseXmlComponent
    • +
  • XmlAttributeComponent
    • @@ -45,7 +47,9 @@
    • rootKey: string
    -

    Returns BaseXmlComponent

    +

    Returns BaseXmlComponent

    Methods

    @@ -58,7 +62,9 @@
    -

    Returns undefined | IXmlableObject

    +

    Returns undefined | IXmlableObject

    diff --git a/api/classes/Body.html b/api/classes/Body.html index 1bbeafd97b..e44f15ea48 100644 --- a/api/classes/Body.html +++ b/api/classes/Body.html @@ -18,7 +18,9 @@ +
  • Body
    • @@ -43,7 +45,9 @@
  • new Body(): Body

  • Returns Body

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -57,7 +61,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    addSection

    -

    Returns void

    +

    Returns void

    prepForXml

    Returns undefined | IXmlableObject

    +

    Overrides XmlComponent.prepForXml

    +

    push

    +

    Returns void

    diff --git a/api/classes/Bookmark.html b/api/classes/Bookmark.html index 2d4b6c9f6b..432fa64e4c 100644 --- a/api/classes/Bookmark.html +++ b/api/classes/Bookmark.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • Bookmark
    +
  • Bookmark
    • @@ -49,24 +51,26 @@
    Readonly children: ParagraphChild[]
  • Readonly id: string
    • -

    Returns Bookmark

    +

    Returns Bookmark

    Properties

    Readonly children

    children: ParagraphChild[]
    +
  • Defined in src/file/paragraph/links/bookmark.ts:10

    • Readonly end

    end: BookmarkEnd
    +
  • Defined in src/file/paragraph/links/bookmark.ts:11

    • Readonly start

    start: BookmarkStart
    +
  • Defined in src/file/paragraph/links/bookmark.ts:9
    • diff --git a/api/classes/BookmarkEnd.html b/api/classes/BookmarkEnd.html index c353ebe928..94e4d31a73 100644 --- a/api/classes/BookmarkEnd.html +++ b/api/classes/BookmarkEnd.html @@ -18,7 +18,9 @@ +
  • BookmarkEnd
    • @@ -46,7 +48,9 @@
  • linkId: number

    • Returns BookmarkEnd

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/BookmarkStart.html b/api/classes/BookmarkStart.html index 541a09a781..3587cbaf50 100644 --- a/api/classes/BookmarkStart.html +++ b/api/classes/BookmarkStart.html @@ -18,7 +18,9 @@ +
  • BookmarkStart
    • @@ -48,7 +50,9 @@
  • linkId: number

    • Returns BookmarkStart

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Border.html b/api/classes/Border.html index 07b958059c..332bff2a15 100644 --- a/api/classes/Border.html +++ b/api/classes/Border.html @@ -18,7 +18,9 @@ +
  • Border
    • @@ -46,7 +48,9 @@
  • options: IBordersOptions

    • Returns Border

    +

    Overrides IgnoreIfEmptyXmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from IgnoreIfEmptyXmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from IgnoreIfEmptyXmlComponent.prepForXml

    +
    diff --git a/api/classes/BorderElement.html b/api/classes/BorderElement.html index 83e6d84a28..1f28386e03 100644 --- a/api/classes/BorderElement.html +++ b/api/classes/BorderElement.html @@ -18,7 +18,9 @@ +
  • BorderElement
    • @@ -48,7 +50,9 @@
  • __namedParameters: IBorderOptions

    • Returns BorderElement

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Column.html b/api/classes/Column.html index ff30db9574..5888ed97da 100644 --- a/api/classes/Column.html +++ b/api/classes/Column.html @@ -18,7 +18,9 @@ +
  • Column
    • @@ -46,7 +48,9 @@
  • __namedParameters: IColumnAttributes

    • Returns Column

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/ColumnAttributes.html b/api/classes/ColumnAttributes.html index 81834c9dec..e9e4611267 100644 --- a/api/classes/ColumnAttributes.html +++ b/api/classes/ColumnAttributes.html @@ -18,7 +18,9 @@ +
  • ColumnAttributes
    • @@ -45,7 +47,9 @@
  • properties: IColumnAttributes

    • Returns ColumnAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -59,7 +63,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/ColumnBreak.html b/api/classes/ColumnBreak.html index 508acaa985..eb58fcd2ac 100644 --- a/api/classes/ColumnBreak.html +++ b/api/classes/ColumnBreak.html @@ -18,7 +18,9 @@
    • Run
        -
      • ColumnBreak
    +
  • ColumnBreak
    • @@ -41,7 +43,9 @@

  • Returns ColumnBreak

    • +

    Overrides Run.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from Run.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from Run.prepForXml

    +
    diff --git a/api/classes/Columns.html b/api/classes/Columns.html index e0ba419868..a02bf5eaea 100644 --- a/api/classes/Columns.html +++ b/api/classes/Columns.html @@ -18,7 +18,9 @@ +
  • Columns
    • @@ -46,7 +48,9 @@
  • __namedParameters: IColumnsAttributes

    • Returns Columns

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/ColumnsAttributes.html b/api/classes/ColumnsAttributes.html index 31b72d2ff5..7190f15463 100644 --- a/api/classes/ColumnsAttributes.html +++ b/api/classes/ColumnsAttributes.html @@ -18,7 +18,9 @@ +
  • ColumnsAttributes
    • @@ -45,7 +47,9 @@
  • properties: IColumnsAttributes

    • Returns ColumnsAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -59,7 +63,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/Comment.html b/api/classes/Comment.html index dd31271a79..496d81d732 100644 --- a/api/classes/Comment.html +++ b/api/classes/Comment.html @@ -18,7 +18,9 @@ +
  • Comment
    • @@ -46,7 +48,9 @@
  • __namedParameters: ICommentOptions

    • Returns Comment

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/CommentRangeEnd.html b/api/classes/CommentRangeEnd.html index 28408bbd59..5135157eb4 100644 --- a/api/classes/CommentRangeEnd.html +++ b/api/classes/CommentRangeEnd.html @@ -18,7 +18,9 @@ +
  • CommentRangeEnd
    • @@ -46,7 +48,9 @@
  • id: number

    • Returns CommentRangeEnd

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/CommentRangeStart.html b/api/classes/CommentRangeStart.html index 2e0c3d5594..84319496ff 100644 --- a/api/classes/CommentRangeStart.html +++ b/api/classes/CommentRangeStart.html @@ -18,7 +18,9 @@ +
  • CommentRangeStart
    • @@ -46,7 +48,9 @@
  • id: number

    • Returns CommentRangeStart

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/CommentReference.html b/api/classes/CommentReference.html index ab534a76c3..63d9bba150 100644 --- a/api/classes/CommentReference.html +++ b/api/classes/CommentReference.html @@ -18,7 +18,9 @@ +
  • CommentReference
    • @@ -46,7 +48,9 @@
  • id: number

    • Returns CommentReference

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Comments.html b/api/classes/Comments.html index 42bfcf5827..d352af99b4 100644 --- a/api/classes/Comments.html +++ b/api/classes/Comments.html @@ -18,7 +18,9 @@ +
  • Comments
    • @@ -46,7 +48,9 @@
  • __namedParameters: ICommentsOptions

    • Returns Comments

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/ConcreteHyperlink.html b/api/classes/ConcreteHyperlink.html index 159bd32f42..efdae40c74 100644 --- a/api/classes/ConcreteHyperlink.html +++ b/api/classes/ConcreteHyperlink.html @@ -20,7 +20,9 @@ +
  • InternalHyperlink
    • @@ -56,14 +58,16 @@
  • Optional anchor: string

    • Returns ConcreteHyperlink

    +

    Overrides XmlComponent.constructor

    +

    Properties

    Readonly linkId

    linkId: string
    +
  • Defined in src/file/paragraph/links/hyperlink.ts:14

    • Methods

    @@ -77,7 +81,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/ConcreteNumbering.html b/api/classes/ConcreteNumbering.html index d147df7f65..dd6627c2f4 100644 --- a/api/classes/ConcreteNumbering.html +++ b/api/classes/ConcreteNumbering.html @@ -18,7 +18,9 @@ +
  • ConcreteNumbering
    • @@ -52,24 +54,26 @@
  • options: IConcreteNumberingOptions

    • Returns ConcreteNumbering

    +

    Overrides XmlComponent.constructor

    +

    Properties

    Readonly instance

    instance: number
    +
  • Defined in src/file/numbering/num.ts:46

    • Readonly numId

    numId: number
    +
  • Defined in src/file/numbering/num.ts:44

    • Readonly reference

    reference: string
    +
  • Defined in src/file/numbering/num.ts:45

    • Methods

    @@ -83,7 +87,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/DeletedTextRun.html b/api/classes/DeletedTextRun.html index d685910b80..04ece3f0d0 100644 --- a/api/classes/DeletedTextRun.html +++ b/api/classes/DeletedTextRun.html @@ -18,7 +18,9 @@ +
  • DeletedTextRun
    • @@ -46,7 +48,9 @@
  • options: IDeletedRunOptions

    • Returns DeletedTextRun

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/DocGridAttributes.html b/api/classes/DocGridAttributes.html index c2ff024153..1101a4f98f 100644 --- a/api/classes/DocGridAttributes.html +++ b/api/classes/DocGridAttributes.html @@ -18,7 +18,9 @@ +
  • DocGridAttributes
    • @@ -45,7 +47,9 @@
  • properties: IDocGridAttributesProperties

    • Returns DocGridAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -59,7 +63,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/Document.html b/api/classes/Document.html index e77fe45829..b996c6db75 100644 --- a/api/classes/Document.html +++ b/api/classes/Document.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • Document
    +
  • Document
    • @@ -57,7 +59,9 @@
    options: IPropertiesOptions
  • fileProperties: IFileProperties = {}
    • -

    Returns Document

    +

    Returns Document

    Accessors

    @@ -65,85 +69,113 @@
    • get AppProperties(): AppProperties
    • -

      Returns AppProperties

    +

    Returns AppProperties

    Comments

    +

    Returns Comments

    ContentTypes

    • get ContentTypes(): ContentTypes
    • -

      Returns ContentTypes

    +

    Returns ContentTypes

    CoreProperties

    • get CoreProperties(): CoreProperties
    • -

      Returns CoreProperties

    +

    Returns CoreProperties

    CustomProperties

    • get CustomProperties(): CustomProperties
    • -

      Returns CustomProperties

    +

    Returns CustomProperties

    Document

    • get Document(): DocumentWrapper
    • -

      Returns DocumentWrapper

    +

    Returns DocumentWrapper

    FileRelationships

    • get FileRelationships(): Relationships
    • -

      Returns Relationships

    +

    Returns Relationships

    FootNotes

    • get FootNotes(): FootnotesWrapper
    • -

      Returns FootnotesWrapper

    +

    Returns FootnotesWrapper

    Footers

    +

    Returns FooterWrapper[]

    Headers

    +

    Returns HeaderWrapper[]

    Media

    +

    Returns Media

    Numbering

    +

    Returns Numbering

    Settings

    • get Settings(): Settings
    • -

      Returns Settings

    +

    Returns Settings

    Styles

    +

    Returns Styles

    diff --git a/api/classes/DocumentAttributes.html b/api/classes/DocumentAttributes.html index ab364f074e..9e438056c8 100644 --- a/api/classes/DocumentAttributes.html +++ b/api/classes/DocumentAttributes.html @@ -18,7 +18,9 @@ +
  • DocumentAttributes
    • @@ -45,7 +47,9 @@
  • properties: IDocumentAttributesProperties

    • Returns DocumentAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -59,7 +63,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/DocumentBackground.html b/api/classes/DocumentBackground.html index cb53b7bd9c..4e9288b3a6 100644 --- a/api/classes/DocumentBackground.html +++ b/api/classes/DocumentBackground.html @@ -18,7 +18,9 @@ +
  • DocumentBackground
    • @@ -46,7 +48,9 @@
  • options: IDocumentBackgroundOptions

    • Returns DocumentBackground

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/DocumentBackgroundAttributes.html b/api/classes/DocumentBackgroundAttributes.html index 464a93d4c1..f2420ca13f 100644 --- a/api/classes/DocumentBackgroundAttributes.html +++ b/api/classes/DocumentBackgroundAttributes.html @@ -18,7 +18,9 @@
    • XmlAttributeComponent<{ color?: string; themeColor?: string; themeShade?: string; themeTint?: string }>
        -
      • DocumentBackgroundAttributes
    +
  • DocumentBackgroundAttributes
    • @@ -54,7 +56,9 @@
  • Optional Readonly themeTint?: string

    • Returns DocumentBackgroundAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -68,7 +72,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/DocumentDefaults.html b/api/classes/DocumentDefaults.html index b8f9788eea..b6cde3a9c7 100644 --- a/api/classes/DocumentDefaults.html +++ b/api/classes/DocumentDefaults.html @@ -18,7 +18,9 @@ +
  • DocumentDefaults
    • @@ -46,7 +48,9 @@
  • options: IDocumentDefaultsOptions

    • Returns DocumentDefaults

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/DocumentGrid.html b/api/classes/DocumentGrid.html index 9cf4a5a989..5c68e015ea 100644 --- a/api/classes/DocumentGrid.html +++ b/api/classes/DocumentGrid.html @@ -18,7 +18,9 @@ +
  • DocumentGrid
    • @@ -50,7 +52,9 @@
  • Optional type: DocumentGridType

    • Returns DocumentGrid

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -64,7 +68,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/DotEmphasisMark.html b/api/classes/DotEmphasisMark.html index 79ef41b304..465cc2065f 100644 --- a/api/classes/DotEmphasisMark.html +++ b/api/classes/DotEmphasisMark.html @@ -18,7 +18,9 @@ +
  • DotEmphasisMark
    • @@ -41,7 +43,9 @@

  • Returns DotEmphasisMark

    • +

    Overrides BaseEmphasisMark.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from BaseEmphasisMark.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from BaseEmphasisMark.prepForXml

    +
    diff --git a/api/classes/Drawing.html b/api/classes/Drawing.html index 0b3d2468d4..660d0fc6a8 100644 --- a/api/classes/Drawing.html +++ b/api/classes/Drawing.html @@ -18,7 +18,9 @@ +
  • Drawing
    • @@ -48,7 +50,9 @@
  • drawingOptions: IDrawingOptions = {}

    • Returns Drawing

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/EmphasisMark.html b/api/classes/EmphasisMark.html index 8d6301b94d..dc82dea550 100644 --- a/api/classes/EmphasisMark.html +++ b/api/classes/EmphasisMark.html @@ -18,7 +18,9 @@ +
  • EmphasisMark
    • @@ -46,7 +48,9 @@
  • emphasisMarkType: DOT = EmphasisMarkType.DOT

    • Returns EmphasisMark

    +

    Overrides BaseEmphasisMark.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from BaseEmphasisMark.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from BaseEmphasisMark.prepForXml

    +
    diff --git a/api/classes/ExternalHyperlink.html b/api/classes/ExternalHyperlink.html index f8ec0407ed..4df4572f7b 100644 --- a/api/classes/ExternalHyperlink.html +++ b/api/classes/ExternalHyperlink.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ExternalHyperlink
    +
  • ExternalHyperlink
    • @@ -47,7 +49,9 @@
    Readonly children: ParagraphChild[]
  • Readonly link: string
    • -

    Returns ExternalHyperlink

    +

    Returns ExternalHyperlink

    Properties

    @@ -61,7 +65,7 @@
  • Readonly link: string
    • +
  • Defined in src/file/paragraph/links/hyperlink.ts:42
    • diff --git a/api/classes/FootNoteReferenceRunAttributes.html b/api/classes/FootNoteReferenceRunAttributes.html index 3a05d3b8b1..478e6a3e5b 100644 --- a/api/classes/FootNoteReferenceRunAttributes.html +++ b/api/classes/FootNoteReferenceRunAttributes.html @@ -18,7 +18,9 @@ +
  • FootNoteReferenceRunAttributes
    • @@ -48,7 +50,9 @@
  • Readonly id: number

    • Returns FootNoteReferenceRunAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/FootNotes.html b/api/classes/FootNotes.html index d942b685db..46d21eac1d 100644 --- a/api/classes/FootNotes.html +++ b/api/classes/FootNotes.html @@ -18,7 +18,9 @@ +
  • FootNotes
    • @@ -42,7 +44,9 @@

  • Returns FootNotes

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -56,7 +60,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    createFootNote

      @@ -69,7 +75,9 @@
      id: number
    • paragraph: Paragraph[]
    -

    Returns void

    +

    Returns void

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Footer.html b/api/classes/Footer.html index 67053d6563..61d8c868ca 100644 --- a/api/classes/Footer.html +++ b/api/classes/Footer.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • Footer
    +
  • Footer
    • @@ -42,14 +44,16 @@
    -

    Returns Footer

    +

    Returns Footer

    Properties

    Readonly options

    options: IHeaderOptions = ...
    +
  • Defined in src/file/header.ts:13
    • diff --git a/api/classes/FooterWrapper.html b/api/classes/FooterWrapper.html index d3597ba8e5..ff924f97dd 100644 --- a/api/classes/FooterWrapper.html +++ b/api/classes/FooterWrapper.html @@ -20,7 +20,9 @@

    Implements

      -
    • IViewWrapper
    +
  • IViewWrapper
    • @@ -57,7 +59,9 @@
    referenceId: number
  • Optional initContent: XmlComponent
    • -

    Returns FooterWrapper

    +

    Returns FooterWrapper

    Accessors

    @@ -65,21 +69,27 @@
    +

    Returns Media

    Relationships

    • get Relationships(): Relationships

    • Returns Relationships

    +

    Implementation of IViewWrapper.Relationships

    +

    View

    • get View(): Footer

    • Returns Footer

    +

    Implementation of IViewWrapper.View

    +

    Methods

    @@ -92,7 +102,9 @@
    -

    Returns void

    +

    Returns void

    addChildElement

    +

    Returns void

    diff --git a/api/classes/FootnoteReference.html b/api/classes/FootnoteReference.html index 9ca05c07fd..5f3ed327c1 100644 --- a/api/classes/FootnoteReference.html +++ b/api/classes/FootnoteReference.html @@ -18,7 +18,9 @@ +
  • FootnoteReference
    • @@ -46,7 +48,9 @@
  • id: number

    • Returns FootnoteReference

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/FootnoteReferenceRun.html b/api/classes/FootnoteReferenceRun.html index 8fba728ffd..dc9fa579a7 100644 --- a/api/classes/FootnoteReferenceRun.html +++ b/api/classes/FootnoteReferenceRun.html @@ -18,7 +18,9 @@
    • Run
        -
      • FootnoteReferenceRun
    +
  • FootnoteReferenceRun
    • @@ -46,7 +48,9 @@
  • id: number

    • Returns FootnoteReferenceRun

    +

    Overrides Run.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from Run.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from Run.prepForXml

    +
    diff --git a/api/classes/FrameProperties.html b/api/classes/FrameProperties.html index 5f5f4247b2..2230005e29 100644 --- a/api/classes/FrameProperties.html +++ b/api/classes/FrameProperties.html @@ -18,7 +18,9 @@ +
  • FrameProperties
    • @@ -46,7 +48,9 @@
  • options: IFrameOptions

    • Returns FrameProperties

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/FramePropertiesAttributes.html b/api/classes/FramePropertiesAttributes.html index 02f767f518..08a15d52f1 100644 --- a/api/classes/FramePropertiesAttributes.html +++ b/api/classes/FramePropertiesAttributes.html @@ -18,7 +18,9 @@ +
  • FramePropertiesAttributes
    • @@ -76,7 +78,9 @@
  • Optional Readonly y?: number

    • Returns FramePropertiesAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -90,7 +94,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/GridSpan.html b/api/classes/GridSpan.html index 512b8d0b5c..4358cd64d9 100644 --- a/api/classes/GridSpan.html +++ b/api/classes/GridSpan.html @@ -21,7 +21,9 @@ +
  • GridSpan
    • @@ -49,7 +51,9 @@
  • value: number

    • Returns GridSpan

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -63,7 +67,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Header.html b/api/classes/Header.html index af74161487..40fe6d0153 100644 --- a/api/classes/Header.html +++ b/api/classes/Header.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • Header
    +
  • Header
    • @@ -42,14 +44,16 @@
    -

    Returns Header

    +

    Returns Header

    Properties

    Readonly options

    options: IHeaderOptions = ...
    +
  • Defined in src/file/header.ts:9
    • diff --git a/api/classes/HeaderFooterReference.html b/api/classes/HeaderFooterReference.html index f7a8226756..02e8a3c97b 100644 --- a/api/classes/HeaderFooterReference.html +++ b/api/classes/HeaderFooterReference.html @@ -18,7 +18,9 @@ +
  • HeaderFooterReference
    • @@ -48,7 +50,9 @@
  • options: IHeaderFooterOptions

    • Returns HeaderFooterReference

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/HeaderWrapper.html b/api/classes/HeaderWrapper.html index 7332bbe185..02c5bcaa97 100644 --- a/api/classes/HeaderWrapper.html +++ b/api/classes/HeaderWrapper.html @@ -20,7 +20,9 @@

    Implements

      -
    • IViewWrapper
    +
  • IViewWrapper
    • @@ -57,7 +59,9 @@
    referenceId: number
  • Optional initContent: XmlComponent
    • -

    Returns HeaderWrapper

    +

    Returns HeaderWrapper

    Accessors

    @@ -65,21 +69,27 @@
    +

    Returns Media

    Relationships

    • get Relationships(): Relationships

    • Returns Relationships

    +

    Implementation of IViewWrapper.Relationships

    +

    View

    • get View(): Header

    • Returns Header

    +

    Implementation of IViewWrapper.View

    +

    Methods

    @@ -92,7 +102,9 @@
    -

    Returns HeaderWrapper

    +

    Returns HeaderWrapper

    addChildElement

    +

    Returns void

    diff --git a/api/classes/HorizontalPosition.html b/api/classes/HorizontalPosition.html index 8d8ded89eb..23d0b54ee7 100644 --- a/api/classes/HorizontalPosition.html +++ b/api/classes/HorizontalPosition.html @@ -18,7 +18,9 @@ +
  • HorizontalPosition
    • @@ -46,7 +48,9 @@
  • horizontalPosition: IHorizontalPositionOptions

    • Returns HorizontalPosition

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/HpsMeasureElement.html b/api/classes/HpsMeasureElement.html index ebeeec2404..d8175a8bce 100644 --- a/api/classes/HpsMeasureElement.html +++ b/api/classes/HpsMeasureElement.html @@ -18,7 +18,9 @@ +
  • HpsMeasureElement
    • @@ -48,7 +50,9 @@
  • val: string | number

    • Returns HpsMeasureElement

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/IgnoreIfEmptyXmlComponent.html b/api/classes/IgnoreIfEmptyXmlComponent.html index 55010e73fc..61a053cbec 100644 --- a/api/classes/IgnoreIfEmptyXmlComponent.html +++ b/api/classes/IgnoreIfEmptyXmlComponent.html @@ -26,7 +26,9 @@
  • TableCellBorders
  • TableProperties
  • TableRowProperties
    • -
  • PageBorders
    • +
  • PageBorders
    • @@ -54,7 +56,9 @@
  • rootKey: string

    • Returns IgnoreIfEmptyXmlComponent

    +

    Inherited from XmlComponent.constructor

    +

    Methods

    @@ -68,7 +72,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Overrides XmlComponent.prepForXml

    +
    diff --git a/api/classes/ImageRun.html b/api/classes/ImageRun.html index ada70d028a..ff8c39d671 100644 --- a/api/classes/ImageRun.html +++ b/api/classes/ImageRun.html @@ -18,7 +18,9 @@ +
  • ImageRun
    • @@ -46,7 +48,9 @@
  • options: IImageOptions

    • Returns ImageRun

    +

    Overrides Run.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from Run.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Overrides Run.prepForXml

    +
    diff --git a/api/classes/ImportDotx.html b/api/classes/ImportDotx.html index 7818ca928a..69c3831135 100644 --- a/api/classes/ImportDotx.html +++ b/api/classes/ImportDotx.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ImportDotx
    +
  • ImportDotx
    • @@ -50,7 +52,9 @@
    • data: string | number[] | ArrayBuffer | Uint8Array | Blob | Buffer | ReadableStream
    -

    Returns Promise<IDocumentTemplate>

    +

    Returns Promise<IDocumentTemplate>

    diff --git a/api/classes/ImportedRootElementAttributes.html b/api/classes/ImportedRootElementAttributes.html index ef49876f0e..69a1e5d7f6 100644 --- a/api/classes/ImportedRootElementAttributes.html +++ b/api/classes/ImportedRootElementAttributes.html @@ -21,7 +21,9 @@ +
  • ImportedRootElementAttributes
    • @@ -49,7 +51,9 @@
  • _attr: any

    • Returns ImportedRootElementAttributes

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -63,7 +67,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns IXmlableObject

    +

    Overrides XmlComponent.prepForXml

    +
    diff --git a/api/classes/ImportedXmlComponent.html b/api/classes/ImportedXmlComponent.html index 1a31248a0b..24de45ec10 100644 --- a/api/classes/ImportedXmlComponent.html +++ b/api/classes/ImportedXmlComponent.html @@ -21,7 +21,9 @@ +
  • ImportedXmlComponent
    • @@ -55,7 +57,9 @@
  • Optional _attr: any

    • Returns ImportedXmlComponent

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -69,7 +73,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +

    push

    +

    Returns void

    Static fromXmlString

    -

    Returns ImportedXmlComponent

    +

    Returns ImportedXmlComponent

    diff --git a/api/classes/Indent.html b/api/classes/Indent.html index 46ed53a2b1..f631b9a5b9 100644 --- a/api/classes/Indent.html +++ b/api/classes/Indent.html @@ -18,7 +18,9 @@ +
  • Indent
    • @@ -46,7 +48,9 @@
  • __namedParameters: IIndentAttributesProperties

    • Returns Indent

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/InitializableXmlComponent.html b/api/classes/InitializableXmlComponent.html index 3657ccdaa5..d916220c13 100644 --- a/api/classes/InitializableXmlComponent.html +++ b/api/classes/InitializableXmlComponent.html @@ -18,7 +18,9 @@ +
  • InitializableXmlComponent
    • @@ -48,7 +50,9 @@
  • Optional initComponent: InitializableXmlComponent

    • Returns InitializableXmlComponent

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/InsertedTextRun.html b/api/classes/InsertedTextRun.html index 2df25c061d..456a5409d9 100644 --- a/api/classes/InsertedTextRun.html +++ b/api/classes/InsertedTextRun.html @@ -18,7 +18,9 @@ +
  • InsertedTextRun
    • @@ -46,7 +48,9 @@
  • options: IInsertedRunOptions

    • Returns InsertedTextRun

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/InternalHyperlink.html b/api/classes/InternalHyperlink.html index f73987a28e..1c97d863fb 100644 --- a/api/classes/InternalHyperlink.html +++ b/api/classes/InternalHyperlink.html @@ -18,7 +18,9 @@ +
  • InternalHyperlink
    • @@ -55,7 +57,9 @@
  • Readonly children: ParagraphChild[]

    • Returns InternalHyperlink

    +

    Overrides ConcreteHyperlink.constructor

    +

    Properties

    @@ -63,7 +67,7 @@
    linkId: string
    +
  • Defined in src/file/paragraph/links/hyperlink.ts:14

    • Methods

    @@ -77,7 +81,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from ConcreteHyperlink.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from ConcreteHyperlink.prepForXml

    +
    diff --git a/api/classes/Level.html b/api/classes/Level.html index ce9a51b521..94d7a9070a 100644 --- a/api/classes/Level.html +++ b/api/classes/Level.html @@ -18,7 +18,9 @@ +
  • Level
    • @@ -46,7 +48,9 @@
  • options: ILevelsOptions

    • Returns Level

    +

    Overrides LevelBase.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from LevelBase.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from LevelBase.prepForXml

    +
    diff --git a/api/classes/LevelBase.html b/api/classes/LevelBase.html index 99a1111e79..d6c6265326 100644 --- a/api/classes/LevelBase.html +++ b/api/classes/LevelBase.html @@ -21,7 +21,9 @@
  • LevelBase
    • +
  • LevelForOverride
    • @@ -49,7 +51,9 @@
  • __namedParameters: ILevelsOptions

    • Returns LevelBase

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -63,7 +67,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/LevelForOverride.html b/api/classes/LevelForOverride.html index 7a22d9eb8b..b68583f942 100644 --- a/api/classes/LevelForOverride.html +++ b/api/classes/LevelForOverride.html @@ -18,7 +18,9 @@ +
  • LevelForOverride
    • @@ -46,7 +48,9 @@
  • __namedParameters: ILevelsOptions

    • Returns LevelForOverride

    +

    Inherited from LevelBase.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from LevelBase.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from LevelBase.prepForXml

    +
    diff --git a/api/classes/LevelOverride.html b/api/classes/LevelOverride.html index f4067a4169..7e03a78e80 100644 --- a/api/classes/LevelOverride.html +++ b/api/classes/LevelOverride.html @@ -18,7 +18,9 @@ +
  • LevelOverride
    • @@ -48,7 +50,9 @@
  • Optional start: number

    • Returns LevelOverride

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/LineNumberAttributes.html b/api/classes/LineNumberAttributes.html index 91023f76f9..4f254e7da8 100644 --- a/api/classes/LineNumberAttributes.html +++ b/api/classes/LineNumberAttributes.html @@ -18,7 +18,9 @@ +
  • LineNumberAttributes
    • @@ -45,7 +47,9 @@
  • properties: ILineNumberAttributes

    • Returns LineNumberAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -59,7 +63,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/LineNumberType.html b/api/classes/LineNumberType.html index 505d797bfc..070e0f25b1 100644 --- a/api/classes/LineNumberType.html +++ b/api/classes/LineNumberType.html @@ -18,7 +18,9 @@ +
  • LineNumberType
    • @@ -46,7 +48,9 @@
  • __namedParameters: ILineNumberAttributes

    • Returns LineNumberType

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Math.html b/api/classes/Math.html index f786fa0ce4..a0f670308f 100644 --- a/api/classes/Math.html +++ b/api/classes/Math.html @@ -18,7 +18,9 @@ +
  • Math
    • @@ -46,7 +48,9 @@
  • options: IMathOptions

    • Returns Math

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathAccentCharacter.html b/api/classes/MathAccentCharacter.html index 5912b68bcb..4a5a08b66d 100644 --- a/api/classes/MathAccentCharacter.html +++ b/api/classes/MathAccentCharacter.html @@ -18,7 +18,9 @@ +
  • MathAccentCharacter
    • @@ -46,7 +48,9 @@
  • accent: string

    • Returns MathAccentCharacter

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathAngledBrackets.html b/api/classes/MathAngledBrackets.html index fb208a7f05..facb3be6bb 100644 --- a/api/classes/MathAngledBrackets.html +++ b/api/classes/MathAngledBrackets.html @@ -18,7 +18,9 @@ +
  • MathAngledBrackets
    • @@ -49,7 +51,9 @@
  • Readonly children: MathComponent[]

    • Returns MathAngledBrackets

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -63,7 +67,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathBase.html b/api/classes/MathBase.html index 8e1a3496bc..f1ebab6d60 100644 --- a/api/classes/MathBase.html +++ b/api/classes/MathBase.html @@ -18,7 +18,9 @@ +
  • MathBase
    • @@ -46,7 +48,9 @@
  • children: MathComponent[]

    • Returns MathBase

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathCurlyBrackets.html b/api/classes/MathCurlyBrackets.html index de28b1a80a..ee96b32dee 100644 --- a/api/classes/MathCurlyBrackets.html +++ b/api/classes/MathCurlyBrackets.html @@ -18,7 +18,9 @@ +
  • MathCurlyBrackets
    • @@ -49,7 +51,9 @@
  • Readonly children: MathComponent[]

    • Returns MathCurlyBrackets

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -63,7 +67,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathDegree.html b/api/classes/MathDegree.html index 74e9ca52dc..66e64576bc 100644 --- a/api/classes/MathDegree.html +++ b/api/classes/MathDegree.html @@ -18,7 +18,9 @@ +
  • MathDegree
    • @@ -46,7 +48,9 @@
  • Optional children: MathComponent[]

    • Returns MathDegree

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathDenominator.html b/api/classes/MathDenominator.html index 7b135504f0..b5969adca7 100644 --- a/api/classes/MathDenominator.html +++ b/api/classes/MathDenominator.html @@ -18,7 +18,9 @@ +
  • MathDenominator
    • @@ -46,7 +48,9 @@
  • children: MathComponent[]

    • Returns MathDenominator

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathFraction.html b/api/classes/MathFraction.html index 52934dda04..de7a88d39a 100644 --- a/api/classes/MathFraction.html +++ b/api/classes/MathFraction.html @@ -18,7 +18,9 @@ +
  • MathFraction
    • @@ -46,7 +48,9 @@
  • options: IMathFractionOptions

    • Returns MathFraction

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathFunction.html b/api/classes/MathFunction.html index 9bbca1e2ae..3f3a067a64 100644 --- a/api/classes/MathFunction.html +++ b/api/classes/MathFunction.html @@ -18,7 +18,9 @@ +
  • MathFunction
    • @@ -46,7 +48,9 @@
  • options: IMathFunctionOptions

    • Returns MathFunction

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathFunctionName.html b/api/classes/MathFunctionName.html index 4d0abff01c..d7463b71f7 100644 --- a/api/classes/MathFunctionName.html +++ b/api/classes/MathFunctionName.html @@ -18,7 +18,9 @@ +
  • MathFunctionName
    • @@ -46,7 +48,9 @@
  • children: MathComponent[]

    • Returns MathFunctionName

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathFunctionProperties.html b/api/classes/MathFunctionProperties.html index 6ae1dfb0b4..d0b72083c2 100644 --- a/api/classes/MathFunctionProperties.html +++ b/api/classes/MathFunctionProperties.html @@ -18,7 +18,9 @@ +
  • MathFunctionProperties
    • @@ -41,7 +43,9 @@

  • Returns MathFunctionProperties

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathLimitLocation.html b/api/classes/MathLimitLocation.html index 14f3b0c5e6..b55176fdbe 100644 --- a/api/classes/MathLimitLocation.html +++ b/api/classes/MathLimitLocation.html @@ -18,7 +18,9 @@ +
  • MathLimitLocation
    • @@ -41,7 +43,9 @@

  • Returns MathLimitLocation

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathNAryProperties.html b/api/classes/MathNAryProperties.html index fdb4110d76..94adfb6bf2 100644 --- a/api/classes/MathNAryProperties.html +++ b/api/classes/MathNAryProperties.html @@ -18,7 +18,9 @@ +
  • MathNAryProperties
    • @@ -50,7 +52,9 @@
  • hasSubScript: boolean

    • Returns MathNAryProperties

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -64,7 +68,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathNumerator.html b/api/classes/MathNumerator.html index 39787b24fb..9c3fd97173 100644 --- a/api/classes/MathNumerator.html +++ b/api/classes/MathNumerator.html @@ -18,7 +18,9 @@ +
  • MathNumerator
    • @@ -46,7 +48,9 @@
  • children: MathComponent[]

    • Returns MathNumerator

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathPreSubSuperScript.html b/api/classes/MathPreSubSuperScript.html index b0daa14ad0..09696540a2 100644 --- a/api/classes/MathPreSubSuperScript.html +++ b/api/classes/MathPreSubSuperScript.html @@ -18,7 +18,9 @@ +
  • MathPreSubSuperScript
    • @@ -46,7 +48,9 @@
  • options: IMathPreSubSuperScriptOptions

    • Returns MathPreSubSuperScript

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathPreSubSuperScriptProperties.html b/api/classes/MathPreSubSuperScriptProperties.html index b75f7f8186..1dbafd2581 100644 --- a/api/classes/MathPreSubSuperScriptProperties.html +++ b/api/classes/MathPreSubSuperScriptProperties.html @@ -18,7 +18,9 @@ +
  • MathPreSubSuperScriptProperties
    • @@ -41,7 +43,9 @@

  • Returns MathPreSubSuperScriptProperties

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathRadical.html b/api/classes/MathRadical.html index 4090f0a02b..3a46f330d1 100644 --- a/api/classes/MathRadical.html +++ b/api/classes/MathRadical.html @@ -18,7 +18,9 @@ +
  • MathRadical
    • @@ -46,7 +48,9 @@
  • options: IMathRadicalOptions

    • Returns MathRadical

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathRadicalProperties.html b/api/classes/MathRadicalProperties.html index c9549d226c..e6577281e4 100644 --- a/api/classes/MathRadicalProperties.html +++ b/api/classes/MathRadicalProperties.html @@ -18,7 +18,9 @@ +
  • MathRadicalProperties
    • @@ -46,7 +48,9 @@
  • hasDegree: boolean

    • Returns MathRadicalProperties

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathRoundBrackets.html b/api/classes/MathRoundBrackets.html index 504fcbe0d9..64c59f0738 100644 --- a/api/classes/MathRoundBrackets.html +++ b/api/classes/MathRoundBrackets.html @@ -18,7 +18,9 @@ +
  • MathRoundBrackets
    • @@ -49,7 +51,9 @@
  • Readonly children: MathComponent[]

    • Returns MathRoundBrackets

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -63,7 +67,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathRun.html b/api/classes/MathRun.html index a69114c9d0..8e81765c65 100644 --- a/api/classes/MathRun.html +++ b/api/classes/MathRun.html @@ -18,7 +18,9 @@ +
  • MathRun
    • @@ -46,7 +48,9 @@
  • text: string

    • Returns MathRun

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathSquareBrackets.html b/api/classes/MathSquareBrackets.html index 98d1d12b0a..ca9750f086 100644 --- a/api/classes/MathSquareBrackets.html +++ b/api/classes/MathSquareBrackets.html @@ -18,7 +18,9 @@ +
  • MathSquareBrackets
    • @@ -49,7 +51,9 @@
  • Readonly children: MathComponent[]

    • Returns MathSquareBrackets

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -63,7 +67,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathSubScript.html b/api/classes/MathSubScript.html index 73d412b4a2..77de1f9747 100644 --- a/api/classes/MathSubScript.html +++ b/api/classes/MathSubScript.html @@ -18,7 +18,9 @@ +
  • MathSubScript
    • @@ -46,7 +48,9 @@
  • options: IMathSubScriptOptions

    • Returns MathSubScript

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathSubScriptElement.html b/api/classes/MathSubScriptElement.html index ce9fe1bf29..caf70360b2 100644 --- a/api/classes/MathSubScriptElement.html +++ b/api/classes/MathSubScriptElement.html @@ -18,7 +18,9 @@ +
  • MathSubScriptElement
    • @@ -46,7 +48,9 @@
  • children: MathComponent[]

    • Returns MathSubScriptElement

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathSubScriptProperties.html b/api/classes/MathSubScriptProperties.html index e910c99be7..655b300d6b 100644 --- a/api/classes/MathSubScriptProperties.html +++ b/api/classes/MathSubScriptProperties.html @@ -18,7 +18,9 @@ +
  • MathSubScriptProperties
    • @@ -41,7 +43,9 @@

  • Returns MathSubScriptProperties

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathSubSuperScript.html b/api/classes/MathSubSuperScript.html index 40cc549e4e..cee5517e80 100644 --- a/api/classes/MathSubSuperScript.html +++ b/api/classes/MathSubSuperScript.html @@ -18,7 +18,9 @@ +
  • MathSubSuperScript
    • @@ -46,7 +48,9 @@
  • options: IMathSubSuperScriptOptions

    • Returns MathSubSuperScript

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathSubSuperScriptProperties.html b/api/classes/MathSubSuperScriptProperties.html index 45255e6d95..876c753464 100644 --- a/api/classes/MathSubSuperScriptProperties.html +++ b/api/classes/MathSubSuperScriptProperties.html @@ -18,7 +18,9 @@ +
  • MathSubSuperScriptProperties
    • @@ -41,7 +43,9 @@

  • Returns MathSubSuperScriptProperties

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathSum.html b/api/classes/MathSum.html index fea5b6cfe4..4adc69bf3e 100644 --- a/api/classes/MathSum.html +++ b/api/classes/MathSum.html @@ -18,7 +18,9 @@ +
  • MathSum
    • @@ -46,7 +48,9 @@
  • options: IMathSumOptions

    • Returns MathSum

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathSuperScript.html b/api/classes/MathSuperScript.html index 52a54566b6..6204e6d25e 100644 --- a/api/classes/MathSuperScript.html +++ b/api/classes/MathSuperScript.html @@ -18,7 +18,9 @@ +
  • MathSuperScript
    • @@ -46,7 +48,9 @@
  • options: IMathSuperScriptOptions

    • Returns MathSuperScript

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathSuperScriptElement.html b/api/classes/MathSuperScriptElement.html index 301a6efeff..f127f4bc5b 100644 --- a/api/classes/MathSuperScriptElement.html +++ b/api/classes/MathSuperScriptElement.html @@ -18,7 +18,9 @@ +
  • MathSuperScriptElement
    • @@ -46,7 +48,9 @@
  • children: MathComponent[]

    • Returns MathSuperScriptElement

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/MathSuperScriptProperties.html b/api/classes/MathSuperScriptProperties.html index 298972079c..2ea043700b 100644 --- a/api/classes/MathSuperScriptProperties.html +++ b/api/classes/MathSuperScriptProperties.html @@ -18,7 +18,9 @@ +
  • MathSuperScriptProperties
    • @@ -41,7 +43,9 @@

  • Returns MathSuperScriptProperties

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Media.html b/api/classes/Media.html index a665b84c59..a3f17d7537 100644 --- a/api/classes/Media.html +++ b/api/classes/Media.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • Media
    +
  • Media
    • @@ -42,7 +44,9 @@
    +

    Returns Media

    Accessors

    @@ -50,7 +54,9 @@
    +

    Returns readonly IMediaData[]

    Methods

    @@ -65,7 +71,9 @@
    key: string
  • mediaData: IMediaData
    • -

    Returns void

    +

    Returns void

    addMedia

      @@ -78,7 +86,9 @@
      data: string | ArrayBuffer | Uint8Array | Buffer
    • transformation: IMediaTransformation
    -

    Returns IMediaData

    +

    Returns IMediaData

    diff --git a/api/classes/NumberProperties.html b/api/classes/NumberProperties.html index 530445776a..243ac76159 100644 --- a/api/classes/NumberProperties.html +++ b/api/classes/NumberProperties.html @@ -18,7 +18,9 @@ +
  • NumberProperties
    • @@ -48,7 +50,9 @@
  • indentLevel: number

    • Returns NumberProperties

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/NumberValueElement.html b/api/classes/NumberValueElement.html index c619601c63..9f73266518 100644 --- a/api/classes/NumberValueElement.html +++ b/api/classes/NumberValueElement.html @@ -18,7 +18,9 @@ +
  • NumberValueElement
    • @@ -48,7 +50,9 @@
  • val: number

    • Returns NumberValueElement

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Numbering.html b/api/classes/Numbering.html index 8758965078..88932b01bf 100644 --- a/api/classes/Numbering.html +++ b/api/classes/Numbering.html @@ -18,7 +18,9 @@ +
  • Numbering
    • @@ -52,7 +54,9 @@
  • options: INumberingOptions

    • Returns Numbering

    +

    Overrides XmlComponent.constructor

    +

    Accessors

    @@ -60,13 +64,17 @@
    +

    Returns ConcreteNumbering[]

    ReferenceConfig

    • get ReferenceConfig(): object[]
    • -

      Returns object[]

    +

    Returns object[]

    Methods

    @@ -80,7 +88,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    createConcreteNumberingInstance

    -

    Returns void

    +

    Returns void

    prepForXml

    Returns undefined | IXmlableObject

    +

    Overrides XmlComponent.prepForXml

    +
    diff --git a/api/classes/OnOffElement.html b/api/classes/OnOffElement.html index 1c025cb043..1e60596e84 100644 --- a/api/classes/OnOffElement.html +++ b/api/classes/OnOffElement.html @@ -18,7 +18,9 @@ +
  • OnOffElement
    • @@ -48,7 +50,9 @@
  • val: undefined | boolean = true

    • Returns OnOffElement

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/OutlineLevel.html b/api/classes/OutlineLevel.html index 3e31d6cd44..22b66ea121 100644 --- a/api/classes/OutlineLevel.html +++ b/api/classes/OutlineLevel.html @@ -18,7 +18,9 @@ +
  • OutlineLevel
    • @@ -50,14 +52,16 @@
  • level: number

    • Returns OutlineLevel

    +

    Overrides XmlComponent.constructor

    +

    Properties

    Readonly level

    level: number
    +
  • Defined in src/file/paragraph/links/outline-level.ts:5

    • Methods

    @@ -71,7 +75,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Packer.html b/api/classes/Packer.html index 829ecbd8d9..0cddcd6282 100644 --- a/api/classes/Packer.html +++ b/api/classes/Packer.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • Packer
    +
  • Packer
    • @@ -54,7 +56,9 @@
    file: Document
  • Optional prettify: boolean | PrettifyType
    • -

    Returns Promise<string>

    +

    Returns Promise<string>

    Static toBlob

    -

    Returns Promise<Blob>

    +

    Returns Promise<Blob>

    Static toBuffer

    -

    Returns Promise<Buffer>

    +

    Returns Promise<Buffer>

    diff --git a/api/classes/PageBorders.html b/api/classes/PageBorders.html index 2b9d37d78c..91c8b9e372 100644 --- a/api/classes/PageBorders.html +++ b/api/classes/PageBorders.html @@ -18,7 +18,9 @@ +
  • PageBorders
    • @@ -46,7 +48,9 @@
  • Optional options: IPageBordersOptions

    • Returns PageBorders

    +

    Overrides IgnoreIfEmptyXmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from IgnoreIfEmptyXmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from IgnoreIfEmptyXmlComponent.prepForXml

    +
    diff --git a/api/classes/PageBreak.html b/api/classes/PageBreak.html index 0464893176..b316554ccc 100644 --- a/api/classes/PageBreak.html +++ b/api/classes/PageBreak.html @@ -18,7 +18,9 @@
    • Run
        -
      • PageBreak
    +
  • PageBreak
    • @@ -41,7 +43,9 @@

  • Returns PageBreak

    • +

    Overrides Run.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from Run.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from Run.prepForXml

    +
    diff --git a/api/classes/PageBreakBefore.html b/api/classes/PageBreakBefore.html index b5fe0d7176..62d95b9c98 100644 --- a/api/classes/PageBreakBefore.html +++ b/api/classes/PageBreakBefore.html @@ -21,7 +21,9 @@ +
  • PageBreakBefore
    • @@ -44,7 +46,9 @@

  • Returns PageBreakBefore

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -58,7 +62,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/PageMargin.html b/api/classes/PageMargin.html index 57b2111d3b..6966cb9e40 100644 --- a/api/classes/PageMargin.html +++ b/api/classes/PageMargin.html @@ -18,7 +18,9 @@ +
  • PageMargin
    • @@ -58,7 +60,9 @@
  • gutter: string | number

    • Returns PageMargin

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -72,7 +76,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/PageMarginAttributes.html b/api/classes/PageMarginAttributes.html index 0b90509d44..e695214312 100644 --- a/api/classes/PageMarginAttributes.html +++ b/api/classes/PageMarginAttributes.html @@ -18,7 +18,9 @@ +
  • PageMarginAttributes
    • @@ -45,7 +47,9 @@
  • properties: IPageMarginAttributes

    • Returns PageMarginAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -59,7 +63,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/PageNumberType.html b/api/classes/PageNumberType.html index 79c33f89cd..f40991a561 100644 --- a/api/classes/PageNumberType.html +++ b/api/classes/PageNumberType.html @@ -18,7 +18,9 @@ +
  • PageNumberType
    • @@ -46,7 +48,9 @@
  • __namedParameters: IPageNumberTypeAttributes

    • Returns PageNumberType

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/PageNumberTypeAttributes.html b/api/classes/PageNumberTypeAttributes.html index 3798fffda6..07fd3eefb7 100644 --- a/api/classes/PageNumberTypeAttributes.html +++ b/api/classes/PageNumberTypeAttributes.html @@ -18,7 +18,9 @@ +
  • PageNumberTypeAttributes
    • @@ -45,7 +47,9 @@
  • properties: IPageNumberTypeAttributes

    • Returns PageNumberTypeAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -59,7 +63,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/PageReference.html b/api/classes/PageReference.html index be81f9420d..25a79f7227 100644 --- a/api/classes/PageReference.html +++ b/api/classes/PageReference.html @@ -18,7 +18,9 @@
    • Run
        -
      • PageReference
    +
  • PageReference
    • @@ -48,7 +50,9 @@
  • options: IPageReferenceOptions = {}

    • Returns PageReference

    +

    Overrides Run.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from Run.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from Run.prepForXml

    +
    diff --git a/api/classes/PageSize.html b/api/classes/PageSize.html index 4f334c6c96..3c3ccf51a9 100644 --- a/api/classes/PageSize.html +++ b/api/classes/PageSize.html @@ -18,7 +18,9 @@ +
  • PageSize
    • @@ -50,7 +52,9 @@
  • orientation: PageOrientation

    • Returns PageSize

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -64,7 +68,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/PageSizeAttributes.html b/api/classes/PageSizeAttributes.html index 6769bc8806..14304c172b 100644 --- a/api/classes/PageSizeAttributes.html +++ b/api/classes/PageSizeAttributes.html @@ -18,7 +18,9 @@ +
  • PageSizeAttributes
    • @@ -45,7 +47,9 @@
  • properties: IPageSizeAttributes

    • Returns PageSizeAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -59,7 +63,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/PageTextDirection.html b/api/classes/PageTextDirection.html index 295feb3739..b6c766254c 100644 --- a/api/classes/PageTextDirection.html +++ b/api/classes/PageTextDirection.html @@ -18,7 +18,9 @@ +
  • PageTextDirection
    • @@ -46,7 +48,9 @@
  • value: PageTextDirectionType

    • Returns PageTextDirection

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Paragraph.html b/api/classes/Paragraph.html index b53f8fd658..f6614083c2 100644 --- a/api/classes/Paragraph.html +++ b/api/classes/Paragraph.html @@ -18,7 +18,9 @@ +
  • Paragraph
    • @@ -47,7 +49,9 @@
  • options: string | IParagraphOptions

    • Returns Paragraph

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -61,7 +65,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    addRunToFront

    +

    Returns Paragraph

    prepForXml

    Returns undefined | IXmlableObject

    +

    Overrides XmlComponent.prepForXml

    +
    diff --git a/api/classes/ParagraphProperties.html b/api/classes/ParagraphProperties.html index aa2eaf99b4..4790162637 100644 --- a/api/classes/ParagraphProperties.html +++ b/api/classes/ParagraphProperties.html @@ -18,7 +18,9 @@ +
  • ParagraphProperties
    • @@ -47,7 +49,9 @@
  • Optional options: IParagraphPropertiesOptions

    • Returns ParagraphProperties

    +

    Overrides IgnoreIfEmptyXmlComponent.constructor

    +

    Methods

    @@ -61,7 +65,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from IgnoreIfEmptyXmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Overrides IgnoreIfEmptyXmlComponent.prepForXml

    +

    push

    +

    Returns void

    diff --git a/api/classes/ParagraphPropertiesDefaults.html b/api/classes/ParagraphPropertiesDefaults.html index 55a39ab834..a4da003caa 100644 --- a/api/classes/ParagraphPropertiesDefaults.html +++ b/api/classes/ParagraphPropertiesDefaults.html @@ -18,7 +18,9 @@ +
  • ParagraphPropertiesDefaults
    • @@ -46,7 +48,9 @@
  • Optional options: IParagraphStylePropertiesOptions

    • Returns ParagraphPropertiesDefaults

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Run.html b/api/classes/Run.html index eca7dcb9a6..dd976f13dc 100644 --- a/api/classes/Run.html +++ b/api/classes/Run.html @@ -27,7 +27,9 @@
  • ImageRun
  • SequentialIdentifier
  • PageReference
    • -
  • FootnoteReferenceRun
    • +
  • FootnoteReferenceRun
    • @@ -55,7 +57,9 @@
  • options: IRunOptions

    • Returns Run

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -69,7 +73,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/RunFonts.html b/api/classes/RunFonts.html index 2ef4c7dd72..1617fdf241 100644 --- a/api/classes/RunFonts.html +++ b/api/classes/RunFonts.html @@ -18,7 +18,9 @@ +
  • RunFonts
    • @@ -48,7 +50,9 @@
  • Optional hint: string

    • Returns RunFonts

    +

    Overrides XmlComponent.constructor

    +
  • @@ -57,7 +61,9 @@
  • attrs: string | IFontAttributesProperties

    • Returns RunFonts

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -71,7 +77,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/RunProperties.html b/api/classes/RunProperties.html index 77842f0376..b5064552a3 100644 --- a/api/classes/RunProperties.html +++ b/api/classes/RunProperties.html @@ -18,7 +18,9 @@ +
  • RunProperties
    • @@ -47,7 +49,9 @@
  • Optional options: IRunPropertiesOptions

    • Returns RunProperties

    +

    Overrides IgnoreIfEmptyXmlComponent.constructor

    +

    Methods

    @@ -61,7 +65,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from IgnoreIfEmptyXmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from IgnoreIfEmptyXmlComponent.prepForXml

    +

    push

    +

    Returns void

    diff --git a/api/classes/RunPropertiesChange.html b/api/classes/RunPropertiesChange.html index 6363a86139..d2ee35aacc 100644 --- a/api/classes/RunPropertiesChange.html +++ b/api/classes/RunPropertiesChange.html @@ -18,7 +18,9 @@ +
  • RunPropertiesChange
    • @@ -46,7 +48,9 @@
  • options: IRunPropertiesChangeOptions

    • Returns RunPropertiesChange

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/RunPropertiesDefaults.html b/api/classes/RunPropertiesDefaults.html index 268fb6c294..70c7c6aa30 100644 --- a/api/classes/RunPropertiesDefaults.html +++ b/api/classes/RunPropertiesDefaults.html @@ -18,7 +18,9 @@ +
  • RunPropertiesDefaults
    • @@ -46,7 +48,9 @@
  • Optional options: IRunStylePropertiesOptions

    • Returns RunPropertiesDefaults

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/SectionProperties.html b/api/classes/SectionProperties.html index 1c5007a532..a5eb5ec692 100644 --- a/api/classes/SectionProperties.html +++ b/api/classes/SectionProperties.html @@ -18,7 +18,9 @@ +
  • SectionProperties
    • @@ -46,7 +48,9 @@
  • __namedParameters: ISectionPropertiesOptions = {}

    • Returns SectionProperties

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/SectionTypeAttributes.html b/api/classes/SectionTypeAttributes.html index c33ddb43f9..4ee30b715f 100644 --- a/api/classes/SectionTypeAttributes.html +++ b/api/classes/SectionTypeAttributes.html @@ -18,7 +18,9 @@ +
  • SectionTypeAttributes
    • @@ -48,7 +50,9 @@
  • Readonly val: SectionType

    • Returns SectionTypeAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/SequentialIdentifier.html b/api/classes/SequentialIdentifier.html index 520cf267cb..41e4b91303 100644 --- a/api/classes/SequentialIdentifier.html +++ b/api/classes/SequentialIdentifier.html @@ -18,7 +18,9 @@
    • Run
        -
      • SequentialIdentifier
    +
  • SequentialIdentifier
    • @@ -46,7 +48,9 @@
  • identifier: string

    • Returns SequentialIdentifier

    +

    Overrides Run.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from Run.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from Run.prepForXml

    +
    diff --git a/api/classes/Shading.html b/api/classes/Shading.html index db00dd4691..e9121e7984 100644 --- a/api/classes/Shading.html +++ b/api/classes/Shading.html @@ -18,7 +18,9 @@ +
  • Shading
    • @@ -46,7 +48,9 @@
  • __namedParameters: IShadingAttributesProperties

    • Returns Shading

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/SimpleField.html b/api/classes/SimpleField.html index 72fbf094e6..826aae644e 100644 --- a/api/classes/SimpleField.html +++ b/api/classes/SimpleField.html @@ -20,7 +20,9 @@ +
  • SimpleMailMergeField
    • @@ -50,7 +52,9 @@
  • Optional cachedValue: string

    • Returns SimpleField

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -64,7 +68,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/SimpleMailMergeField.html b/api/classes/SimpleMailMergeField.html index 6047e9cbc4..2c9effc1dd 100644 --- a/api/classes/SimpleMailMergeField.html +++ b/api/classes/SimpleMailMergeField.html @@ -18,7 +18,9 @@ +
  • SimpleMailMergeField
    • @@ -46,7 +48,9 @@
  • fieldName: string

    • Returns SimpleMailMergeField

    +

    Overrides SimpleField.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from SimpleField.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from SimpleField.prepForXml

    +
    diff --git a/api/classes/SimplePos.html b/api/classes/SimplePos.html index 911f8e9ea4..c866da8ae9 100644 --- a/api/classes/SimplePos.html +++ b/api/classes/SimplePos.html @@ -18,7 +18,9 @@ +
  • SimplePos
    • @@ -41,7 +43,9 @@

  • Returns SimplePos

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Spacing.html b/api/classes/Spacing.html index 48229dca7f..99f3d646e2 100644 --- a/api/classes/Spacing.html +++ b/api/classes/Spacing.html @@ -18,7 +18,9 @@ +
  • Spacing
    • @@ -46,7 +48,9 @@
  • options: ISpacingProperties

    • Returns Spacing

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/StringContainer.html b/api/classes/StringContainer.html index 512d6a67bf..7a5c319948 100644 --- a/api/classes/StringContainer.html +++ b/api/classes/StringContainer.html @@ -18,7 +18,9 @@ +
  • StringContainer
    • @@ -48,7 +50,9 @@
  • val: string

    • Returns StringContainer

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/StringValueElement.html b/api/classes/StringValueElement.html index 63626b44f7..144ac897cd 100644 --- a/api/classes/StringValueElement.html +++ b/api/classes/StringValueElement.html @@ -18,7 +18,9 @@ +
  • StringValueElement
    • @@ -48,7 +50,9 @@
  • val: string

    • Returns StringValueElement

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Style.html b/api/classes/Style.html index 1159dc7557..24cd3ef98f 100644 --- a/api/classes/Style.html +++ b/api/classes/Style.html @@ -18,7 +18,9 @@ +
  • Style
    • @@ -46,7 +48,9 @@
  • styleId: string

    • Returns Style

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/StyleForCharacter.html b/api/classes/StyleForCharacter.html index 39d7c1626f..c2826b96b7 100644 --- a/api/classes/StyleForCharacter.html +++ b/api/classes/StyleForCharacter.html @@ -18,7 +18,9 @@
    • Style
        -
      • StyleForCharacter
    +
  • StyleForCharacter
    • @@ -46,7 +48,9 @@
  • options: ICharacterStyleOptions

    • Returns StyleForCharacter

    +

    Overrides Style.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from Style.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from Style.prepForXml

    +
    diff --git a/api/classes/StyleForParagraph.html b/api/classes/StyleForParagraph.html index 908bd6d46e..9d6fe541ab 100644 --- a/api/classes/StyleForParagraph.html +++ b/api/classes/StyleForParagraph.html @@ -18,7 +18,9 @@
    • Style
        -
      • StyleForParagraph
    +
  • StyleForParagraph
    • @@ -46,7 +48,9 @@
  • options: IParagraphStyleOptions

    • Returns StyleForParagraph

    +

    Overrides Style.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from Style.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from Style.prepForXml

    +
    diff --git a/api/classes/StyleLevel.html b/api/classes/StyleLevel.html index 2ece02e089..0831399bc1 100644 --- a/api/classes/StyleLevel.html +++ b/api/classes/StyleLevel.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • StyleLevel
    +
  • StyleLevel
    • @@ -45,19 +47,21 @@
    styleName: string
  • level: number
    • -

    Returns StyleLevel

    +

    Returns StyleLevel

    Properties

    Readonly level

    level: number
    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:3

    • Readonly styleName

    styleName: string
    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:2
    • diff --git a/api/classes/Styles.html b/api/classes/Styles.html index 173f356211..2563ddf3f7 100644 --- a/api/classes/Styles.html +++ b/api/classes/Styles.html @@ -18,7 +18,9 @@ +
  • Styles
    • @@ -46,7 +48,9 @@
  • options: IStylesOptions

    • Returns Styles

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/SymbolRun.html b/api/classes/SymbolRun.html index 05707560ad..8c15230211 100644 --- a/api/classes/SymbolRun.html +++ b/api/classes/SymbolRun.html @@ -18,7 +18,9 @@
    • Run
        -
      • SymbolRun
    +
  • SymbolRun
    • @@ -46,7 +48,9 @@
  • options: string | ISymbolRunOptions

    • Returns SymbolRun

    +

    Overrides Run.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from Run.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from Run.prepForXml

    +
    diff --git a/api/classes/TDirection.html b/api/classes/TDirection.html index 9bb69ff9f0..751d2096d9 100644 --- a/api/classes/TDirection.html +++ b/api/classes/TDirection.html @@ -21,7 +21,9 @@ +
  • TDirection
    • @@ -49,7 +51,9 @@
  • value: TextDirection

    • Returns TDirection

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -63,7 +67,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Tab.html b/api/classes/Tab.html index 81469afa79..80e96460d3 100644 --- a/api/classes/Tab.html +++ b/api/classes/Tab.html @@ -18,7 +18,9 @@ +
  • Tab
    • @@ -41,7 +43,9 @@

  • Returns Tab

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/TabAttributes.html b/api/classes/TabAttributes.html index 3095fb5c98..e9ff282d4f 100644 --- a/api/classes/TabAttributes.html +++ b/api/classes/TabAttributes.html @@ -18,7 +18,9 @@ +
  • TabAttributes
    • @@ -52,7 +54,9 @@
  • Readonly val: TabStopType

    • Returns TabAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -66,7 +70,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/TabStop.html b/api/classes/TabStop.html index 8cd8192ce5..fd713b6f1d 100644 --- a/api/classes/TabStop.html +++ b/api/classes/TabStop.html @@ -18,7 +18,9 @@ +
  • TabStop
    • @@ -50,7 +52,9 @@
  • Optional leader: LeaderType

    • Returns TabStop

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -64,7 +68,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/TabStopItem.html b/api/classes/TabStopItem.html index 4292e86bfe..760314bfa7 100644 --- a/api/classes/TabStopItem.html +++ b/api/classes/TabStopItem.html @@ -18,7 +18,9 @@ +
  • TabStopItem
    • @@ -50,7 +52,9 @@
  • Optional leader: LeaderType

    • Returns TabStopItem

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -64,7 +68,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Table.html b/api/classes/Table.html index 43f106ff63..5c720573b4 100644 --- a/api/classes/Table.html +++ b/api/classes/Table.html @@ -18,7 +18,9 @@ +
  • Table
    • @@ -46,7 +48,9 @@
  • __namedParameters: ITableOptions

    • Returns Table

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/TableBorders.html b/api/classes/TableBorders.html index 9c93d13b8f..75fc591fa1 100644 --- a/api/classes/TableBorders.html +++ b/api/classes/TableBorders.html @@ -18,7 +18,9 @@ +
  • TableBorders
    • @@ -50,7 +52,9 @@
  • options: ITableBordersOptions

    • Returns TableBorders

    +

    Overrides XmlComponent.constructor

    +

    Properties

    @@ -114,7 +118,7 @@
  • style: BorderStyle
    • +
  • Defined in src/file/table/table-properties/table-borders.ts:27

    • Methods

    @@ -128,7 +132,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/TableCell.html b/api/classes/TableCell.html index 017efb18d5..ab454a7153 100644 --- a/api/classes/TableCell.html +++ b/api/classes/TableCell.html @@ -18,7 +18,9 @@ +
  • TableCell
    • @@ -50,14 +52,16 @@
  • options: ITableCellOptions

    • Returns TableCell

    +

    Overrides XmlComponent.constructor

    +

    Properties

    Readonly options

    options: ITableCellOptions
    +
  • Defined in src/file/table/table-cell/table-cell.ts:13

    • Methods

    @@ -71,7 +75,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Overrides XmlComponent.prepForXml

    +
    diff --git a/api/classes/TableCellBorders.html b/api/classes/TableCellBorders.html index b8e81cc312..0b1bec6b62 100644 --- a/api/classes/TableCellBorders.html +++ b/api/classes/TableCellBorders.html @@ -18,7 +18,9 @@ +
  • TableCellBorders
    • @@ -46,7 +48,9 @@
  • options: ITableCellBorders

    • Returns TableCellBorders

    +

    Overrides IgnoreIfEmptyXmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from IgnoreIfEmptyXmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from IgnoreIfEmptyXmlComponent.prepForXml

    +
    diff --git a/api/classes/TableFloatOptionsAttributes.html b/api/classes/TableFloatOptionsAttributes.html index aaee7d7a37..eb6a3d2c0b 100644 --- a/api/classes/TableFloatOptionsAttributes.html +++ b/api/classes/TableFloatOptionsAttributes.html @@ -18,7 +18,9 @@ +
  • TableFloatOptionsAttributes
    • @@ -45,7 +47,9 @@
  • properties: ITableFloatOptions

    • Returns TableFloatOptionsAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -59,7 +63,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/TableFloatProperties.html b/api/classes/TableFloatProperties.html index b64b92a784..a03b9d89da 100644 --- a/api/classes/TableFloatProperties.html +++ b/api/classes/TableFloatProperties.html @@ -18,7 +18,9 @@ +
  • TableFloatProperties
    • @@ -46,7 +48,9 @@
  • __namedParameters: ITableFloatOptions

    • Returns TableFloatProperties

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/TableLayout.html b/api/classes/TableLayout.html index 4fdeb1d2ee..a82d66e5da 100644 --- a/api/classes/TableLayout.html +++ b/api/classes/TableLayout.html @@ -18,7 +18,9 @@ +
  • TableLayout
    • @@ -46,7 +48,9 @@
  • type: TableLayoutType

    • Returns TableLayout

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/TableOfContents.html b/api/classes/TableOfContents.html index d67aded63c..6aa71883d1 100644 --- a/api/classes/TableOfContents.html +++ b/api/classes/TableOfContents.html @@ -18,7 +18,9 @@ +
  • TableOfContents
    • @@ -48,7 +50,9 @@
  • Optional properties: ITableOfContentsOptions

    • Returns TableOfContents

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/TableOverlap.html b/api/classes/TableOverlap.html index 6b05b22480..bce4851547 100644 --- a/api/classes/TableOverlap.html +++ b/api/classes/TableOverlap.html @@ -18,7 +18,9 @@ +
  • TableOverlap
    • @@ -46,7 +48,9 @@
  • type: OverlapType

    • Returns TableOverlap

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/TableProperties.html b/api/classes/TableProperties.html index c8370085b5..ef7b7a326c 100644 --- a/api/classes/TableProperties.html +++ b/api/classes/TableProperties.html @@ -18,7 +18,9 @@ +
  • TableProperties
    • @@ -46,7 +48,9 @@
  • options: ITablePropertiesOptions

    • Returns TableProperties

    +

    Overrides IgnoreIfEmptyXmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from IgnoreIfEmptyXmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from IgnoreIfEmptyXmlComponent.prepForXml

    +
    diff --git a/api/classes/TableRow.html b/api/classes/TableRow.html index 61eab455ea..c49dc4c21c 100644 --- a/api/classes/TableRow.html +++ b/api/classes/TableRow.html @@ -18,7 +18,9 @@ +
  • TableRow
    • @@ -55,7 +57,9 @@
  • options: ITableRowOptions

    • Returns TableRow

    +

    Overrides XmlComponent.constructor

    +

    Accessors

    @@ -63,13 +67,17 @@
    • get CellCount(): number
    • -

      Returns number

    +

    Returns number

    cells

    +

    Returns TableCell[]

    Methods

    @@ -84,7 +92,9 @@
    cell: TableCell
  • columnIndex: number
    • -

    Returns void

    +

    Returns void

    addCellToIndex

    -

    Returns void

    +

    Returns void

    addChildElement

    Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    columnIndexToRootIndex

    -

    Returns number

    +

    Returns number

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +

    rootIndexToColumnIndex

    +

    Returns number

    diff --git a/api/classes/TableRowHeight.html b/api/classes/TableRowHeight.html index decc40a636..ae5477394e 100644 --- a/api/classes/TableRowHeight.html +++ b/api/classes/TableRowHeight.html @@ -18,7 +18,9 @@ +
  • TableRowHeight
    • @@ -48,7 +50,9 @@
  • rule: HeightRule

    • Returns TableRowHeight

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/TableRowHeightAttributes.html b/api/classes/TableRowHeightAttributes.html index d0c12f8ba0..b41d3166b5 100644 --- a/api/classes/TableRowHeightAttributes.html +++ b/api/classes/TableRowHeightAttributes.html @@ -18,7 +18,9 @@ +
  • TableRowHeightAttributes
    • @@ -50,7 +52,9 @@
  • Readonly value: string | number

    • Returns TableRowHeightAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -64,7 +68,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/TableRowProperties.html b/api/classes/TableRowProperties.html index bfa4965c02..5b18843dfb 100644 --- a/api/classes/TableRowProperties.html +++ b/api/classes/TableRowProperties.html @@ -18,7 +18,9 @@ +
  • TableRowProperties
    • @@ -46,7 +48,9 @@
  • options: ITableRowPropertiesOptions

    • Returns TableRowProperties

    +

    Overrides IgnoreIfEmptyXmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from IgnoreIfEmptyXmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from IgnoreIfEmptyXmlComponent.prepForXml

    +
    diff --git a/api/classes/TableWidthElement.html b/api/classes/TableWidthElement.html index 196be01503..9329ee27d0 100644 --- a/api/classes/TableWidthElement.html +++ b/api/classes/TableWidthElement.html @@ -18,7 +18,9 @@ +
  • TableWidthElement
    • @@ -48,7 +50,9 @@
  • __namedParameters: ITableWidthProperties

    • Returns TableWidthElement

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/TextRun.html b/api/classes/TextRun.html index c279d3cee1..b40cd62e9c 100644 --- a/api/classes/TextRun.html +++ b/api/classes/TextRun.html @@ -18,7 +18,9 @@ +
  • TextRun
    • @@ -46,7 +48,9 @@
  • options: string | IRunOptions

    • Returns TextRun

    +

    Overrides Run.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from Run.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from Run.prepForXml

    +
    diff --git a/api/classes/ThematicBreak.html b/api/classes/ThematicBreak.html index 0479db4b90..1af3ab28c1 100644 --- a/api/classes/ThematicBreak.html +++ b/api/classes/ThematicBreak.html @@ -18,7 +18,9 @@ +
  • ThematicBreak
    • @@ -41,7 +43,9 @@

  • Returns ThematicBreak

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Type.html b/api/classes/Type.html index 01c9e92085..92f84dbafa 100644 --- a/api/classes/Type.html +++ b/api/classes/Type.html @@ -18,7 +18,9 @@ +
  • Type
    • @@ -46,7 +48,9 @@
  • value: SectionType

    • Returns Type

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/Underline.html b/api/classes/Underline.html index 063ff1d7a6..c9e6f123c2 100644 --- a/api/classes/Underline.html +++ b/api/classes/Underline.html @@ -18,7 +18,9 @@ +
  • Underline
    • @@ -48,7 +50,9 @@
  • Optional color: string

    • Returns Underline

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/VerticalAlignAttributes.html b/api/classes/VerticalAlignAttributes.html index e2c3772df2..c1ab239685 100644 --- a/api/classes/VerticalAlignAttributes.html +++ b/api/classes/VerticalAlignAttributes.html @@ -18,7 +18,9 @@ +
  • VerticalAlignAttributes
    • @@ -48,7 +50,9 @@
  • Optional Readonly verticalAlign?: VerticalAlign

    • Returns VerticalAlignAttributes

    +

    Inherited from XmlAttributeComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Inherited from XmlAttributeComponent.prepForXml

    +
    diff --git a/api/classes/VerticalAlignElement.html b/api/classes/VerticalAlignElement.html index db27c98fe3..70d82b1b85 100644 --- a/api/classes/VerticalAlignElement.html +++ b/api/classes/VerticalAlignElement.html @@ -18,7 +18,9 @@ +
  • VerticalAlignElement
    • @@ -46,7 +48,9 @@
  • value: VerticalAlign

    • Returns VerticalAlignElement

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/VerticalMerge.html b/api/classes/VerticalMerge.html index c437c7c392..98167be0a7 100644 --- a/api/classes/VerticalMerge.html +++ b/api/classes/VerticalMerge.html @@ -21,7 +21,9 @@ +
  • VerticalMerge
    • @@ -49,7 +51,9 @@
  • value: VerticalMergeType

    • Returns VerticalMerge

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -63,7 +67,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/VerticalPosition.html b/api/classes/VerticalPosition.html index 45ad9fd7b9..4fcfcea04f 100644 --- a/api/classes/VerticalPosition.html +++ b/api/classes/VerticalPosition.html @@ -18,7 +18,9 @@ +
  • VerticalPosition
    • @@ -46,7 +48,9 @@
  • verticalPosition: IVerticalPositionOptions

    • Returns VerticalPosition

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/WrapNone.html b/api/classes/WrapNone.html index d84d5999e5..24ccbaf0ce 100644 --- a/api/classes/WrapNone.html +++ b/api/classes/WrapNone.html @@ -18,7 +18,9 @@ +
  • WrapNone
    • @@ -41,7 +43,9 @@

  • Returns WrapNone

    • +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -55,7 +59,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/WrapSquare.html b/api/classes/WrapSquare.html index a80809d8a8..94bf79f01a 100644 --- a/api/classes/WrapSquare.html +++ b/api/classes/WrapSquare.html @@ -18,7 +18,9 @@ +
  • WrapSquare
    • @@ -48,7 +50,9 @@
  • margins: IMargins = ...

    • Returns WrapSquare

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -62,7 +66,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/WrapTight.html b/api/classes/WrapTight.html index 9c2b573d56..10ed227748 100644 --- a/api/classes/WrapTight.html +++ b/api/classes/WrapTight.html @@ -18,7 +18,9 @@ +
  • WrapTight
    • @@ -46,7 +48,9 @@
  • margins: IMargins = ...

    • Returns WrapTight

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/WrapTopAndBottom.html b/api/classes/WrapTopAndBottom.html index 3ac0e1881a..e575cdc7ba 100644 --- a/api/classes/WrapTopAndBottom.html +++ b/api/classes/WrapTopAndBottom.html @@ -18,7 +18,9 @@ +
  • WrapTopAndBottom
    • @@ -46,7 +48,9 @@
  • margins: IMargins = ...

    • Returns WrapTopAndBottom

    +

    Overrides XmlComponent.constructor

    +

    Methods

    @@ -60,7 +64,9 @@
  • child: string | XmlComponent

    • Returns XmlComponent

    +

    Inherited from XmlComponent.addChildElement

    +

    prepForXml

    Returns undefined | IXmlableObject

    +

    Inherited from XmlComponent.prepForXml

    +
    diff --git a/api/classes/XmlAttributeComponent.html b/api/classes/XmlAttributeComponent.html index c414158be2..a744ab2fcc 100644 --- a/api/classes/XmlAttributeComponent.html +++ b/api/classes/XmlAttributeComponent.html @@ -42,7 +42,9 @@
  • DocumentBackgroundAttributes
  • Attributes
  • FootNoteReferenceRunAttributes
    • -
  • VerticalAlignAttributes
    • +
  • VerticalAlignAttributes
    • @@ -74,7 +76,9 @@
  • properties: T

    • Returns XmlAttributeComponent<T>

    +

    Overrides BaseXmlComponent.constructor

    +

    Methods

    @@ -88,7 +92,9 @@
  • _: IContext

    • Returns IXmlableObject

    +

    Overrides BaseXmlComponent.prepForXml

    +
    diff --git a/api/classes/XmlComponent.html b/api/classes/XmlComponent.html index 1d70b2b4ff..fea06b313b 100644 --- a/api/classes/XmlComponent.html +++ b/api/classes/XmlComponent.html @@ -135,7 +135,9 @@
  • InsertedTextRun
  • DeletedTextRun
  • BorderElement
    • -
  • VerticalAlignElement
    • +
  • VerticalAlignElement
    • @@ -163,7 +165,9 @@
  • rootKey: string

    • Returns XmlComponent

    +

    Overrides BaseXmlComponent.constructor

    +

    Methods

    @@ -176,7 +180,9 @@
    -

    Returns XmlComponent

    +

    Returns XmlComponent

    prepForXml

    Returns undefined | IXmlableObject

    +

    Overrides BaseXmlComponent.prepForXml

    +
    diff --git a/api/enums/AlignmentType.html b/api/enums/AlignmentType.html index 6705858f4b..ee0193d50a 100644 --- a/api/enums/AlignmentType.html +++ b/api/enums/AlignmentType.html @@ -12,7 +12,9 @@ -

    Enumeration AlignmentType

    +

    Enumeration AlignmentType

    @@ -35,42 +37,42 @@

    BOTH

    BOTH: "both"
    +
  • Defined in src/file/paragraph/formatting/alignment.ts:9

    • CENTER

    CENTER: "center"
    +
  • Defined in src/file/paragraph/formatting/alignment.ts:8

    • DISTRIBUTE

    DISTRIBUTE: "distribute"
    +
  • Defined in src/file/paragraph/formatting/alignment.ts:11

    • END

    END: "end"
    +
  • Defined in src/file/paragraph/formatting/alignment.ts:7

    • JUSTIFIED

    JUSTIFIED: "both"
    +
  • Defined in src/file/paragraph/formatting/alignment.ts:10

    • LEFT

    LEFT: "left"
    +
  • Defined in src/file/paragraph/formatting/alignment.ts:12

    • RIGHT

    RIGHT: "right"
    +
  • Defined in src/file/paragraph/formatting/alignment.ts:13

    • START

    START: "start"
    +
  • Defined in src/file/paragraph/formatting/alignment.ts:6
    • diff --git a/api/enums/BorderStyle.html b/api/enums/BorderStyle.html index 71d3656670..71534a4e27 100644 --- a/api/enums/BorderStyle.html +++ b/api/enums/BorderStyle.html @@ -12,7 +12,9 @@ -

    Enumeration BorderStyle

    +

    Enumeration BorderStyle

    @@ -54,137 +56,137 @@

    DASHED

    DASHED: "dashed"
    +
  • Defined in src/file/border/border.ts:61

    • DASH_DOT_STROKED

    DASH_DOT_STROKED: "dashDotStroked"
    +
  • Defined in src/file/border/border.ts:60

    • DASH_SMALL_GAP

    DASH_SMALL_GAP: "dashSmallGap"
    +
  • Defined in src/file/border/border.ts:62

    • DOTTED

    DOTTED: "dotted"
    +
  • Defined in src/file/border/border.ts:65

    • DOT_DASH

    DOT_DASH: "dotDash"
    +
  • Defined in src/file/border/border.ts:63

    • DOT_DOT_DASH

    DOT_DOT_DASH: "dotDotDash"
    +
  • Defined in src/file/border/border.ts:64

    • DOUBLE

    DOUBLE: "double"
    +
  • Defined in src/file/border/border.ts:66

    • DOUBLE_WAVE

    DOUBLE_WAVE: "doubleWave"
    +
  • Defined in src/file/border/border.ts:67

    • INSET

    INSET: "inset"
    +
  • Defined in src/file/border/border.ts:68

    • NIL

    NIL: "nil"
    +
  • Defined in src/file/border/border.ts:69

    • NONE

    NONE: "none"
    +
  • Defined in src/file/border/border.ts:70

    • OUTSET

    OUTSET: "outset"
    +
  • Defined in src/file/border/border.ts:71

    • SINGLE

    SINGLE: "single"
    +
  • Defined in src/file/border/border.ts:59

    • THICK

    THICK: "thick"
    +
  • Defined in src/file/border/border.ts:72

    • THICK_THIN_LARGE_GAP

    THICK_THIN_LARGE_GAP: "thickThinLargeGap"
    +
  • Defined in src/file/border/border.ts:73

    • THICK_THIN_MEDIUM_GAP

    THICK_THIN_MEDIUM_GAP: "thickThinMediumGap"
    +
  • Defined in src/file/border/border.ts:74

    • THICK_THIN_SMALL_GAP

    THICK_THIN_SMALL_GAP: "thickThinSmallGap"
    +
  • Defined in src/file/border/border.ts:75

    • THIN_THICK_LARGE_GAP

    THIN_THICK_LARGE_GAP: "thinThickLargeGap"
    +
  • Defined in src/file/border/border.ts:76

    • THIN_THICK_MEDIUM_GAP

    THIN_THICK_MEDIUM_GAP: "thinThickMediumGap"
    +
  • Defined in src/file/border/border.ts:77

    • THIN_THICK_SMALL_GAP

    THIN_THICK_SMALL_GAP: "thinThickSmallGap"
    +
  • Defined in src/file/border/border.ts:78

    • THIN_THICK_THIN_LARGE_GAP

    THIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap"
    +
  • Defined in src/file/border/border.ts:79

    • THIN_THICK_THIN_MEDIUM_GAP

    THIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap"
    +
  • Defined in src/file/border/border.ts:80

    • THIN_THICK_THIN_SMALL_GAP

    THIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap"
    +
  • Defined in src/file/border/border.ts:81

    • THREE_D_EMBOSS

    THREE_D_EMBOSS: "threeDEmboss"
    +
  • Defined in src/file/border/border.ts:82

    • THREE_D_ENGRAVE

    THREE_D_ENGRAVE: "threeDEngrave"
    +
  • Defined in src/file/border/border.ts:83

    • TRIPLE

    TRIPLE: "triple"
    +
  • Defined in src/file/border/border.ts:84

    • WAVE

    WAVE: "wave"
    +
  • Defined in src/file/border/border.ts:85
    • diff --git a/api/enums/DocumentGridType.html b/api/enums/DocumentGridType.html index 5a4d750845..21a4649c62 100644 --- a/api/enums/DocumentGridType.html +++ b/api/enums/DocumentGridType.html @@ -12,7 +12,9 @@ -

    Enumeration DocumentGridType

    +

    Enumeration DocumentGridType

    @@ -31,22 +33,22 @@

    DEFAULT

    DEFAULT: "default"
    +
  • Defined in src/file/document/body/section-properties/properties/doc-grid.ts:21

    • LINES

    LINES: "lines"
    +
  • Defined in src/file/document/body/section-properties/properties/doc-grid.ts:22

    • LINES_AND_CHARS

    LINES_AND_CHARS: "linesAndChars"
    +
  • Defined in src/file/document/body/section-properties/properties/doc-grid.ts:23

    • SNAP_TO_CHARS

    SNAP_TO_CHARS: "snapToChars"
    +
  • Defined in src/file/document/body/section-properties/properties/doc-grid.ts:24
    • diff --git a/api/enums/DropCapType.html b/api/enums/DropCapType.html index faf2f0ec6a..c666e5a118 100644 --- a/api/enums/DropCapType.html +++ b/api/enums/DropCapType.html @@ -12,7 +12,9 @@ -

    Enumeration DropCapType

    +

    Enumeration DropCapType

    @@ -30,17 +32,17 @@

    DROP

    DROP: "drop"
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:8

    • MARGIN

    MARGIN: "margin"
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:9

    • NONE

    NONE: "none"
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:7
    • diff --git a/api/enums/EmphasisMarkType.html b/api/enums/EmphasisMarkType.html index 87d64aec3f..8b3810acfc 100644 --- a/api/enums/EmphasisMarkType.html +++ b/api/enums/EmphasisMarkType.html @@ -12,7 +12,9 @@ -

    Enumeration EmphasisMarkType

    +

    Enumeration EmphasisMarkType

    @@ -28,7 +30,7 @@

    DOT

    DOT: "dot"
    +
  • Defined in src/file/paragraph/run/emphasis-mark.ts:4
    • diff --git a/api/enums/FrameAnchorType.html b/api/enums/FrameAnchorType.html index c4368189e7..384d1f72ca 100644 --- a/api/enums/FrameAnchorType.html +++ b/api/enums/FrameAnchorType.html @@ -12,7 +12,9 @@ -

    Enumeration FrameAnchorType

    +

    Enumeration FrameAnchorType

    @@ -30,17 +32,17 @@

    MARGIN

    MARGIN: "margin"
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:13

    • PAGE

    PAGE: "page"
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:14

    • TEXT

    TEXT: "text"
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:15
    • diff --git a/api/enums/FrameWrap.html b/api/enums/FrameWrap.html index 7bd9f8fb49..52089fd4c8 100644 --- a/api/enums/FrameWrap.html +++ b/api/enums/FrameWrap.html @@ -12,7 +12,9 @@ -

    Enumeration FrameWrap

    +

    Enumeration FrameWrap

    @@ -33,32 +35,32 @@

    AROUND

    AROUND: "around"
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:19

    • AUTO

    AUTO: "auto"
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:20

    • NONE

    NONE: "none"
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:21

    • NOT_BESIDE

    NOT_BESIDE: "notBeside"
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:22

    • THROUGH

    THROUGH: "through"
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:23

    • TIGHT

    TIGHT: "tight"
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:24
    • diff --git a/api/enums/HeaderFooterReferenceType.html b/api/enums/HeaderFooterReferenceType.html index ab0dbaae4d..3b0bc45c1e 100644 --- a/api/enums/HeaderFooterReferenceType.html +++ b/api/enums/HeaderFooterReferenceType.html @@ -12,7 +12,9 @@ -

    Enumeration HeaderFooterReferenceType

    +

    Enumeration HeaderFooterReferenceType

    @@ -30,17 +32,17 @@

    DEFAULT

    DEFAULT: "default"
    +
  • Defined in src/file/document/body/section-properties/properties/header-footer-reference.ts:11

    • EVEN

    EVEN: "even"
    +
  • Defined in src/file/document/body/section-properties/properties/header-footer-reference.ts:13

    • FIRST

    FIRST: "first"
    +
  • Defined in src/file/document/body/section-properties/properties/header-footer-reference.ts:12
    • diff --git a/api/enums/HeaderFooterType.html b/api/enums/HeaderFooterType.html index 76798d2b72..4678f06394 100644 --- a/api/enums/HeaderFooterType.html +++ b/api/enums/HeaderFooterType.html @@ -12,7 +12,9 @@ -

    Enumeration HeaderFooterType

    +

    Enumeration HeaderFooterType

    @@ -29,12 +31,12 @@

    FOOTER

    FOOTER: "w:footerReference"
    +
  • Defined in src/file/document/body/section-properties/properties/header-footer-reference.ts:52

    • HEADER

    HEADER: "w:headerReference"
    +
  • Defined in src/file/document/body/section-properties/properties/header-footer-reference.ts:51
    • diff --git a/api/enums/HeadingLevel.html b/api/enums/HeadingLevel.html index 472bc0ed50..4edcbf6cf5 100644 --- a/api/enums/HeadingLevel.html +++ b/api/enums/HeadingLevel.html @@ -12,7 +12,9 @@ -

    Enumeration HeadingLevel

    +

    Enumeration HeadingLevel

    @@ -34,37 +36,37 @@

    HEADING_1

    HEADING_1: "Heading1"
    +
  • Defined in src/file/paragraph/formatting/style.ts:4

    • HEADING_2

    HEADING_2: "Heading2"
    +
  • Defined in src/file/paragraph/formatting/style.ts:5

    • HEADING_3

    HEADING_3: "Heading3"
    +
  • Defined in src/file/paragraph/formatting/style.ts:6

    • HEADING_4

    HEADING_4: "Heading4"
    +
  • Defined in src/file/paragraph/formatting/style.ts:7

    • HEADING_5

    HEADING_5: "Heading5"
    +
  • Defined in src/file/paragraph/formatting/style.ts:8

    • HEADING_6

    HEADING_6: "Heading6"
    +
  • Defined in src/file/paragraph/formatting/style.ts:9

    • TITLE

    TITLE: "Title"
    +
  • Defined in src/file/paragraph/formatting/style.ts:10
    • diff --git a/api/enums/HeightRule.html b/api/enums/HeightRule.html index 775af9f8aa..cfbe2fcec4 100644 --- a/api/enums/HeightRule.html +++ b/api/enums/HeightRule.html @@ -12,7 +12,9 @@ -

    Enumeration HeightRule

    +

    Enumeration HeightRule

    @@ -32,21 +34,21 @@

    At least the value specified

    +
  • Defined in src/file/table/table-row/table-row-height.ts:20

    • AUTO

    AUTO: "auto"

    Height is determined based on the content, so value is ignored.

    +
  • Defined in src/file/table/table-row/table-row-height.ts:18

    • EXACT

    EXACT: "exact"

    Exactly the value specified

    +
  • Defined in src/file/table/table-row/table-row-height.ts:22
    • diff --git a/api/enums/HorizontalPositionAlign.html b/api/enums/HorizontalPositionAlign.html index c531993b02..49af4a7c00 100644 --- a/api/enums/HorizontalPositionAlign.html +++ b/api/enums/HorizontalPositionAlign.html @@ -12,7 +12,9 @@ -

    Enumeration HorizontalPositionAlign

    +

    Enumeration HorizontalPositionAlign

    @@ -32,27 +34,27 @@

    CENTER

    CENTER: "center"
    +
  • Defined in src/file/shared/alignment.ts:2

    • INSIDE

    INSIDE: "inside"
    +
  • Defined in src/file/shared/alignment.ts:3

    • LEFT

    LEFT: "left"
    +
  • Defined in src/file/shared/alignment.ts:4

    • OUTSIDE

    OUTSIDE: "outside"
    +
  • Defined in src/file/shared/alignment.ts:5

    • RIGHT

    RIGHT: "right"
    +
  • Defined in src/file/shared/alignment.ts:6
    • diff --git a/api/enums/HorizontalPositionRelativeFrom.html b/api/enums/HorizontalPositionRelativeFrom.html index e4a8093f9b..0e91114d00 100644 --- a/api/enums/HorizontalPositionRelativeFrom.html +++ b/api/enums/HorizontalPositionRelativeFrom.html @@ -12,7 +12,9 @@ -

    Enumeration HorizontalPositionRelativeFrom

    +

    Enumeration HorizontalPositionRelativeFrom

    @@ -35,42 +37,42 @@

    CHARACTER

    CHARACTER: "character"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:8

    • COLUMN

    COLUMN: "column"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:9

    • INSIDE_MARGIN

    INSIDE_MARGIN: "insideMargin"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:10

    • LEFT_MARGIN

    LEFT_MARGIN: "leftMargin"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:11

    • MARGIN

    MARGIN: "margin"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:12

    • OUTSIDE_MARGIN

    OUTSIDE_MARGIN: "outsideMargin"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:13

    • PAGE

    PAGE: "page"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:14

    • RIGHT_MARGIN

    RIGHT_MARGIN: "rightMargin"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:15
    • diff --git a/api/enums/HyperlinkType.html b/api/enums/HyperlinkType.html index b5d13bbde0..7577f73424 100644 --- a/api/enums/HyperlinkType.html +++ b/api/enums/HyperlinkType.html @@ -12,7 +12,9 @@ -

    Enumeration HyperlinkType

    +

    Enumeration HyperlinkType

    @@ -29,12 +31,12 @@

    EXTERNAL

    EXTERNAL: "EXTERNAL"
    +
  • Defined in src/file/paragraph/links/hyperlink.ts:10

    • INTERNAL

    INTERNAL: "INTERNAL"
    +
  • Defined in src/file/paragraph/links/hyperlink.ts:9
    • diff --git a/api/enums/LeaderType.html b/api/enums/LeaderType.html index 4a59f19bb5..d0f8fa757e 100644 --- a/api/enums/LeaderType.html +++ b/api/enums/LeaderType.html @@ -12,7 +12,9 @@ -

    Enumeration LeaderType

    +

    Enumeration LeaderType

    @@ -32,27 +34,27 @@

    DOT

    DOT: "dot"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:24

    • HYPHEN

    HYPHEN: "hyphen"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:25

    • MIDDLE_DOT

    MIDDLE_DOT: "middleDot"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:26

    • NONE

    NONE: "none"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:27

    • UNDERSCORE

    UNDERSCORE: "underscore"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:28
    • diff --git a/api/enums/LevelFormat.html b/api/enums/LevelFormat.html index ac4166680a..aa9abb6f8a 100644 --- a/api/enums/LevelFormat.html +++ b/api/enums/LevelFormat.html @@ -12,7 +12,9 @@ -

    Enumeration LevelFormat

    +

    Enumeration LevelFormat

    @@ -41,72 +43,72 @@

    BULLET

    BULLET: "bullet"
    +
  • Defined in src/file/numbering/level.ts:10

    • CARDINAL_TEXT

    CARDINAL_TEXT: "cardinalText"
    +
  • Defined in src/file/numbering/level.ts:11

    • CHICAGO

    CHICAGO: "chicago"
    +
  • Defined in src/file/numbering/level.ts:12

    • DECIMAL

    DECIMAL: "decimal"
    +
  • Defined in src/file/numbering/level.ts:13

    • DECIMAL_ENCLOSED_CIRCLE

    DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle"
    +
  • Defined in src/file/numbering/level.ts:14

    • DECIMAL_ENCLOSED_FULLSTOP

    DECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop"
    +
  • Defined in src/file/numbering/level.ts:15

    • DECIMAL_ENCLOSED_PARENTHESES

    DECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen"
    +
  • Defined in src/file/numbering/level.ts:16

    • DECIMAL_ZERO

    DECIMAL_ZERO: "decimalZero"
    +
  • Defined in src/file/numbering/level.ts:17

    • LOWER_LETTER

    LOWER_LETTER: "lowerLetter"
    +
  • Defined in src/file/numbering/level.ts:18

    • LOWER_ROMAN

    LOWER_ROMAN: "lowerRoman"
    +
  • Defined in src/file/numbering/level.ts:19

    • NONE

    NONE: "none"
    +
  • Defined in src/file/numbering/level.ts:20

    • ORDINAL_TEXT

    ORDINAL_TEXT: "ordinalText"
    +
  • Defined in src/file/numbering/level.ts:21

    • UPPER_LETTER

    UPPER_LETTER: "upperLetter"
    +
  • Defined in src/file/numbering/level.ts:22

    • UPPER_ROMAN

    UPPER_ROMAN: "upperRoman"
    +
  • Defined in src/file/numbering/level.ts:23
    • diff --git a/api/enums/LevelSuffix.html b/api/enums/LevelSuffix.html index 83fad39825..5ca4ab9b2f 100644 --- a/api/enums/LevelSuffix.html +++ b/api/enums/LevelSuffix.html @@ -12,7 +12,9 @@ -

    Enumeration LevelSuffix

    +

    Enumeration LevelSuffix

    @@ -30,17 +32,17 @@

    NOTHING

    NOTHING: "nothing"
    +
  • Defined in src/file/numbering/level.ts:78

    • SPACE

    SPACE: "space"
    +
  • Defined in src/file/numbering/level.ts:79

    • TAB

    TAB: "tab"
    +
  • Defined in src/file/numbering/level.ts:80
    • diff --git a/api/enums/LineNumberRestartFormat.html b/api/enums/LineNumberRestartFormat.html index e0652ea93d..2beafd5a73 100644 --- a/api/enums/LineNumberRestartFormat.html +++ b/api/enums/LineNumberRestartFormat.html @@ -12,7 +12,9 @@ -

    Enumeration LineNumberRestartFormat

    +

    Enumeration LineNumberRestartFormat

    @@ -30,17 +32,17 @@

    CONTINUOUS

    CONTINUOUS: "continuous"
    +
  • Defined in src/file/document/body/section-properties/properties/line-number.ts:15

    • NEW_PAGE

    NEW_PAGE: "newPage"
    +
  • Defined in src/file/document/body/section-properties/properties/line-number.ts:13

    • NEW_SECTION

    NEW_SECTION: "newSection"
    +
  • Defined in src/file/document/body/section-properties/properties/line-number.ts:14
    • diff --git a/api/enums/LineRuleType.html b/api/enums/LineRuleType.html index d5e637f088..bbde71798c 100644 --- a/api/enums/LineRuleType.html +++ b/api/enums/LineRuleType.html @@ -12,7 +12,9 @@ -

    Enumeration LineRuleType

    +

    Enumeration LineRuleType

    @@ -30,17 +32,17 @@

    AT_LEAST

    AT_LEAST: "atLeast"
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:5

    • AUTO

    AUTO: "auto"
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:7

    • EXACTLY

    EXACTLY: "exactly"
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:6
    • diff --git a/api/enums/NumberFormat.html b/api/enums/NumberFormat.html index 3dbd458835..4e199605ae 100644 --- a/api/enums/NumberFormat.html +++ b/api/enums/NumberFormat.html @@ -12,7 +12,9 @@ -

    Enumeration NumberFormat

    +

    Enumeration NumberFormat

    @@ -89,312 +91,312 @@

    AIUEO

    AIUEO: "aiueo"
    +
  • Defined in src/file/shared/number-format.ts:82

    • AIUEO_FULL_WIDTH

    AIUEO_FULL_WIDTH: "aiueoFullWidth"
    +
  • Defined in src/file/shared/number-format.ts:90

    • ARABIC_ABJAD

    ARABIC_ABJAD: "arabicAbjad"
    +
  • Defined in src/file/shared/number-format.ts:122

    • ARABIC_ALPHA

    ARABIC_ALPHA: "arabicAlpha"
    +
  • Defined in src/file/shared/number-format.ts:121

    • BAHT_TEXT

    BAHT_TEXT: "bahtText"
    +
  • Defined in src/file/shared/number-format.ts:130

    • BULLET

    BULLET: "bullet"
    +
  • Defined in src/file/shared/number-format.ts:93

    • CARDINAL_TEXT

    CARDINAL_TEXT: "cardinalText"
    +
  • Defined in src/file/shared/number-format.ts:76

    • CHICAGO

    CHICAGO: "chicago"
    +
  • Defined in src/file/shared/number-format.ts:79

    • CHINESE_COUNTING

    CHINESE_COUNTING: "chineseCounting"
    +
  • Defined in src/file/shared/number-format.ts:107

    • CHINESE_COUNTING_TEN_THOUSAND

    CHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand"
    +
  • Defined in src/file/shared/number-format.ts:109

    • CHINESE_LEGAL_SIMPLIFIED

    CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified"
    +
  • Defined in src/file/shared/number-format.ts:108

    • CHOSUNG

    CHOSUNG: "chosung"
    +
  • Defined in src/file/shared/number-format.ts:95

    • DECIMAL

    DECIMAL: "decimal"
    +
  • Defined in src/file/shared/number-format.ts:70

    • DECIMAL_ENCLOSED_CIRCLE

    DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle"
    +
  • Defined in src/file/shared/number-format.ts:88

    • DECIMAL_ENCLOSED_CIRCLE_CHINESE

    DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese"
    +
  • Defined in src/file/shared/number-format.ts:98

    • DECIMAL_ENCLOSED_FULL_STOP

    DECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop"
    +
  • Defined in src/file/shared/number-format.ts:96

    • DECIMAL_ENCLOSED_PAREN

    DECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen"
    +
  • Defined in src/file/shared/number-format.ts:97

    • DECIMAL_FULL_WIDTH

    DECIMAL_FULL_WIDTH: "decimalFullWidth"
    +
  • Defined in src/file/shared/number-format.ts:84

    • DECIMAL_FULL_WIDTH_2

    DECIMAL_FULL_WIDTH_2: "decimalFullWidth2"
    +
  • Defined in src/file/shared/number-format.ts:89

    • DECIMAL_HALF_WIDTH

    DECIMAL_HALF_WIDTH: "decimalHalfWidth"
    +
  • Defined in src/file/shared/number-format.ts:85

    • DECIMAL_ZERO

    DECIMAL_ZERO: "decimalZero"
    +
  • Defined in src/file/shared/number-format.ts:92

    • DOLLAR_TEXT

    DOLLAR_TEXT: "dollarText"
    +
  • Defined in src/file/shared/number-format.ts:131

    • GANADA

    GANADA: "ganada"
    +
  • Defined in src/file/shared/number-format.ts:94

    • HEBREW_1

    HEBREW_1: "hebrew1"
    +
  • Defined in src/file/shared/number-format.ts:119

    • HEBREW_2

    HEBREW_2: "hebrew2"
    +
  • Defined in src/file/shared/number-format.ts:120

    • HEX

    HEX: "hex"
    +
  • Defined in src/file/shared/number-format.ts:78

    • HINDI_CONSONANTS

    HINDI_CONSONANTS: "hindiConsonants"
    +
  • Defined in src/file/shared/number-format.ts:124

    • HINDI_COUNTING

    HINDI_COUNTING: "hindiCounting"
    +
  • Defined in src/file/shared/number-format.ts:126

    • HINDI_NUMBERS

    HINDI_NUMBERS: "hindiNumbers"
    +
  • Defined in src/file/shared/number-format.ts:125

    • HINDI_VOWELS

    HINDI_VOWELS: "hindiVowels"
    +
  • Defined in src/file/shared/number-format.ts:123

    • IDEOGRAPH_DIGITAL

    IDEOGRAPH_DIGITAL: "ideographDigital"
    +
  • Defined in src/file/shared/number-format.ts:80

    • IDEOGRAPH_ENCLOSED_CIRCLE

    IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle"
    +
  • Defined in src/file/shared/number-format.ts:99

    • IDEOGRAPH_LEGAL_TRADITIONAL

    IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional"
    +
  • Defined in src/file/shared/number-format.ts:104

    • IDEOGRAPH_TRADITIONAL

    IDEOGRAPH_TRADITIONAL: "ideographTraditional"
    +
  • Defined in src/file/shared/number-format.ts:100

    • IDEOGRAPH_ZODIAC

    IDEOGRAPH_ZODIAC: "ideographZodiac"
    +
  • Defined in src/file/shared/number-format.ts:101

    • IDEOGRAPH_ZODIAC_TRADITIONAL

    IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional"
    +
  • Defined in src/file/shared/number-format.ts:102

    • IROHA

    IROHA: "iroha"
    +
  • Defined in src/file/shared/number-format.ts:83

    • IROHA_FULL_WIDTH

    IROHA_FULL_WIDTH: "irohaFullWidth"
    +
  • Defined in src/file/shared/number-format.ts:91

    • JAPANESE_COUNTING

    JAPANESE_COUNTING: "japaneseCounting"
    +
  • Defined in src/file/shared/number-format.ts:81

    • JAPANESE_DIGITAL_TEN_THOUSAND

    JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand"
    +
  • Defined in src/file/shared/number-format.ts:87

    • JAPANESE_LEGAL

    JAPANESE_LEGAL: "japaneseLegal"
    +
  • Defined in src/file/shared/number-format.ts:86

    • KOREAN_COUNTING

    KOREAN_COUNTING: "koreanCounting"
    +
  • Defined in src/file/shared/number-format.ts:111

    • KOREAN_DIGITAL

    KOREAN_DIGITAL: "koreanDigital"
    +
  • Defined in src/file/shared/number-format.ts:110

    • KOREAN_DIGITAL_2

    KOREAN_DIGITAL_2: "koreanDigital2"
    +
  • Defined in src/file/shared/number-format.ts:113

    • KOREAN_LEGAL

    KOREAN_LEGAL: "koreanLegal"
    +
  • Defined in src/file/shared/number-format.ts:112

    • LOWER_LETTER

    LOWER_LETTER: "lowerLetter"
    +
  • Defined in src/file/shared/number-format.ts:74

    • LOWER_ROMAN

    LOWER_ROMAN: "lowerRoman"
    +
  • Defined in src/file/shared/number-format.ts:72

    • NONE

    NONE: "none"
    +
  • Defined in src/file/shared/number-format.ts:117

    • NUMBER_IN_DASH

    NUMBER_IN_DASH: "numberInDash"
    +
  • Defined in src/file/shared/number-format.ts:118

    • ORDINAL

    ORDINAL: "ordinal"
    +
  • Defined in src/file/shared/number-format.ts:75

    • ORDINAL_TEXT

    ORDINAL_TEXT: "ordinalText"
    +
  • Defined in src/file/shared/number-format.ts:77

    • RUSSIAN_LOWER

    RUSSIAN_LOWER: "russianLower"
    +
  • Defined in src/file/shared/number-format.ts:115

    • RUSSIAN_UPPER

    RUSSIAN_UPPER: "russianUpper"
    +
  • Defined in src/file/shared/number-format.ts:116

    • TAIWANESE_COUNTING

    TAIWANESE_COUNTING: "taiwaneseCounting"
    +
  • Defined in src/file/shared/number-format.ts:103

    • TAIWANESE_COUNTING_THOUSAND

    TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand"
    +
  • Defined in src/file/shared/number-format.ts:105

    • TAIWANESE_DIGITAL

    TAIWANESE_DIGITAL: "taiwaneseDigital"
    +
  • Defined in src/file/shared/number-format.ts:106

    • THAI_COUNTING

    THAI_COUNTING: "thaiCounting"
    +
  • Defined in src/file/shared/number-format.ts:129

    • THAI_LETTERS

    THAI_LETTERS: "thaiLetters"
    +
  • Defined in src/file/shared/number-format.ts:127

    • THAI_NUMBERS

    THAI_NUMBERS: "thaiNumbers"
    +
  • Defined in src/file/shared/number-format.ts:128

    • UPPER_LETTER

    UPPER_LETTER: "upperLetter"
    +
  • Defined in src/file/shared/number-format.ts:73

    • UPPER_ROMAN

    UPPER_ROMAN: "upperRoman"
    +
  • Defined in src/file/shared/number-format.ts:71

    • VIETNAMESE_COUNTING

    VIETNAMESE_COUNTING: "vietnameseCounting"
    +
  • Defined in src/file/shared/number-format.ts:114
    • diff --git a/api/enums/OverlapType.html b/api/enums/OverlapType.html index 63b5deb7f8..0783f7a33b 100644 --- a/api/enums/OverlapType.html +++ b/api/enums/OverlapType.html @@ -12,7 +12,9 @@ -

    Enumeration OverlapType

    +

    Enumeration OverlapType

    @@ -29,12 +31,12 @@

    NEVER

    NEVER: "never"
    +
  • Defined in src/file/table/table-properties/table-overlap.ts:10

    • OVERLAP

    OVERLAP: "overlap"
    +
  • Defined in src/file/table/table-properties/table-overlap.ts:11
    • diff --git a/api/enums/PageBorderDisplay.html b/api/enums/PageBorderDisplay.html index 23066aa25f..789ff08c1a 100644 --- a/api/enums/PageBorderDisplay.html +++ b/api/enums/PageBorderDisplay.html @@ -12,7 +12,9 @@ -

    Enumeration PageBorderDisplay

    +

    Enumeration PageBorderDisplay

    @@ -30,17 +32,17 @@

    ALL_PAGES

    ALL_PAGES: "allPages"
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:13

    • FIRST_PAGE

    FIRST_PAGE: "firstPage"
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:14

    • NOT_FIRST_PAGE

    NOT_FIRST_PAGE: "notFirstPage"
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:15
    • diff --git a/api/enums/PageBorderOffsetFrom.html b/api/enums/PageBorderOffsetFrom.html index 43fd1403c8..5b10f4fd6e 100644 --- a/api/enums/PageBorderOffsetFrom.html +++ b/api/enums/PageBorderOffsetFrom.html @@ -12,7 +12,9 @@ -

    Enumeration PageBorderOffsetFrom

    +

    Enumeration PageBorderOffsetFrom

    @@ -29,12 +31,12 @@

    PAGE

    PAGE: "page"
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:25

    • TEXT

    TEXT: "text"
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:26
    • diff --git a/api/enums/PageBorderZOrder.html b/api/enums/PageBorderZOrder.html index eaa9325b21..446cf33fe5 100644 --- a/api/enums/PageBorderZOrder.html +++ b/api/enums/PageBorderZOrder.html @@ -12,7 +12,9 @@ -

    Enumeration PageBorderZOrder

    +

    Enumeration PageBorderZOrder

    @@ -29,12 +31,12 @@

    BACK

    BACK: "back"
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:36

    • FRONT

    FRONT: "front"
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:37
    • diff --git a/api/enums/PageNumber.html b/api/enums/PageNumber.html index e7e04511ed..20f405a811 100644 --- a/api/enums/PageNumber.html +++ b/api/enums/PageNumber.html @@ -12,7 +12,9 @@ -

    Enumeration PageNumber

    +

    Enumeration PageNumber

    @@ -30,17 +32,17 @@

    CURRENT

    CURRENT: "CURRENT"
    +
  • Defined in src/file/paragraph/run/run.ts:21

    • TOTAL_PAGES

    TOTAL_PAGES: "TOTAL_PAGES"
    +
  • Defined in src/file/paragraph/run/run.ts:22

    • TOTAL_PAGES_IN_SECTION

    TOTAL_PAGES_IN_SECTION: "TOTAL_PAGES_IN_SECTION"
    +
  • Defined in src/file/paragraph/run/run.ts:23
    • diff --git a/api/enums/PageNumberSeparator.html b/api/enums/PageNumberSeparator.html index 9be0b925a4..958c6aea63 100644 --- a/api/enums/PageNumberSeparator.html +++ b/api/enums/PageNumberSeparator.html @@ -12,7 +12,9 @@ -

    Enumeration PageNumberSeparator

    +

    Enumeration PageNumberSeparator

    @@ -32,27 +34,27 @@

    COLON

    COLON: "colon"
    +
  • Defined in src/file/document/body/section-properties/properties/page-number.ts:18

    • EM_DASH

    EM_DASH: "emDash"
    +
  • Defined in src/file/document/body/section-properties/properties/page-number.ts:19

    • EN_DASH

    EN_DASH: "endash"
    +
  • Defined in src/file/document/body/section-properties/properties/page-number.ts:20

    • HYPHEN

    HYPHEN: "hyphen"
    +
  • Defined in src/file/document/body/section-properties/properties/page-number.ts:16

    • PERIOD

    PERIOD: "period"
    +
  • Defined in src/file/document/body/section-properties/properties/page-number.ts:17
    • diff --git a/api/enums/PageOrientation.html b/api/enums/PageOrientation.html index 577c569cd2..7cfe38ca1f 100644 --- a/api/enums/PageOrientation.html +++ b/api/enums/PageOrientation.html @@ -12,7 +12,9 @@ -

    Enumeration PageOrientation

    +

    Enumeration PageOrientation

    @@ -29,12 +31,12 @@

    LANDSCAPE

    LANDSCAPE: "landscape"
    +
  • Defined in src/file/document/body/section-properties/properties/page-size.ts:12

    • PORTRAIT

    PORTRAIT: "portrait"
    +
  • Defined in src/file/document/body/section-properties/properties/page-size.ts:11
    • diff --git a/api/enums/PageTextDirectionType.html b/api/enums/PageTextDirectionType.html index 8cde586bbe..dd012c2b75 100644 --- a/api/enums/PageTextDirectionType.html +++ b/api/enums/PageTextDirectionType.html @@ -12,7 +12,9 @@ -

    Enumeration PageTextDirectionType

    +

    Enumeration PageTextDirectionType

    @@ -29,12 +31,12 @@

    LEFT_TO_RIGHT_TOP_TO_BOTTOM

    LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb"
    +
  • Defined in src/file/document/body/section-properties/properties/page-text-direction.ts:4

    • TOP_TO_BOTTOM_RIGHT_TO_LEFT

    TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl"
    +
  • Defined in src/file/document/body/section-properties/properties/page-text-direction.ts:5
    • diff --git a/api/enums/PrettifyType.html b/api/enums/PrettifyType.html index c9d44f0b3e..0f39006fc6 100644 --- a/api/enums/PrettifyType.html +++ b/api/enums/PrettifyType.html @@ -15,7 +15,9 @@

    Enumeration PrettifyType

    Use blanks to prettify

    -
    +
    @@ -34,22 +36,22 @@

    NONE

    NONE: ""
    +
  • Defined in src/export/packer/packer.ts:9

    • WITH_2_BLANKS

    WITH_2_BLANKS: " "
    +
  • Defined in src/export/packer/packer.ts:10

    • WITH_4_BLANKS

    WITH_4_BLANKS: " "
    +
  • Defined in src/export/packer/packer.ts:11

    • WITH_TAB

    WITH_TAB: "\t"
    +
  • Defined in src/export/packer/packer.ts:12
    • diff --git a/api/enums/RelativeHorizontalPosition.html b/api/enums/RelativeHorizontalPosition.html index aca26807fb..deb2ad1041 100644 --- a/api/enums/RelativeHorizontalPosition.html +++ b/api/enums/RelativeHorizontalPosition.html @@ -12,7 +12,9 @@ -

    Enumeration RelativeHorizontalPosition

    +

    Enumeration RelativeHorizontalPosition

    @@ -32,27 +34,27 @@

    CENTER

    CENTER: "center"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:13

    • INSIDE

    INSIDE: "inside"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:14

    • LEFT

    LEFT: "left"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:15

    • OUTSIDE

    OUTSIDE: "outside"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:16

    • RIGHT

    RIGHT: "right"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:17
    • diff --git a/api/enums/RelativeVerticalPosition.html b/api/enums/RelativeVerticalPosition.html index 9657cbff64..e395aa38fb 100644 --- a/api/enums/RelativeVerticalPosition.html +++ b/api/enums/RelativeVerticalPosition.html @@ -12,7 +12,9 @@ -

    Enumeration RelativeVerticalPosition

    +

    Enumeration RelativeVerticalPosition

    @@ -33,32 +35,32 @@

    BOTTOM

    BOTTOM: "bottom"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:23

    • CENTER

    CENTER: "center"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:21

    • INLINE

    INLINE: "inline"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:25

    • INSIDE

    INSIDE: "inside"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:22

    • OUTSIDE

    OUTSIDE: "outside"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:24

    • TOP

    TOP: "top"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:26
    • diff --git a/api/enums/SectionType.html b/api/enums/SectionType.html index 108226e6f0..787f567fae 100644 --- a/api/enums/SectionType.html +++ b/api/enums/SectionType.html @@ -12,7 +12,9 @@ -

    Enumeration SectionType

    +

    Enumeration SectionType

    @@ -32,27 +34,27 @@

    CONTINUOUS

    CONTINUOUS: "continuous"
    +
  • Defined in src/file/document/body/section-properties/properties/section-type.ts:16

    • EVEN_PAGE

    EVEN_PAGE: "evenPage"
    +
  • Defined in src/file/document/body/section-properties/properties/section-type.ts:17

    • NEXT_COLUMN

    NEXT_COLUMN: "nextColumn"
    +
  • Defined in src/file/document/body/section-properties/properties/section-type.ts:15

    • NEXT_PAGE

    NEXT_PAGE: "nextPage"
    +
  • Defined in src/file/document/body/section-properties/properties/section-type.ts:14

    • ODD_PAGE

    ODD_PAGE: "oddPage"
    +
  • Defined in src/file/document/body/section-properties/properties/section-type.ts:18
    • diff --git a/api/enums/ShadingType.html b/api/enums/ShadingType.html index 7ccd7ea21c..ee0ae296da 100644 --- a/api/enums/ShadingType.html +++ b/api/enums/ShadingType.html @@ -12,7 +12,9 @@ -

    Enumeration ShadingType

    +

    Enumeration ShadingType

    @@ -64,187 +66,187 @@

    CLEAR

    CLEAR: "clear"
    +
  • Defined in src/file/shading/shading.ts:51

    • DIAGONAL_CROSS

    DIAGONAL_CROSS: "diagCross"
    +
  • Defined in src/file/shading/shading.ts:52

    • DIAGONAL_STRIPE

    DIAGONAL_STRIPE: "diagStripe"
    +
  • Defined in src/file/shading/shading.ts:53

    • HORIZONTAL_CROSS

    HORIZONTAL_CROSS: "horzCross"
    +
  • Defined in src/file/shading/shading.ts:54

    • HORIZONTAL_STRIPE

    HORIZONTAL_STRIPE: "horzStripe"
    +
  • Defined in src/file/shading/shading.ts:55

    • NIL

    NIL: "nil"
    +
  • Defined in src/file/shading/shading.ts:56

    • PERCENT_10

    PERCENT_10: "pct10"
    +
  • Defined in src/file/shading/shading.ts:58

    • PERCENT_12

    PERCENT_12: "pct12"
    +
  • Defined in src/file/shading/shading.ts:59

    • PERCENT_15

    PERCENT_15: "pct15"
    +
  • Defined in src/file/shading/shading.ts:60

    • PERCENT_20

    PERCENT_20: "pct20"
    +
  • Defined in src/file/shading/shading.ts:61

    • PERCENT_25

    PERCENT_25: "pct25"
    +
  • Defined in src/file/shading/shading.ts:62

    • PERCENT_30

    PERCENT_30: "pct30"
    +
  • Defined in src/file/shading/shading.ts:63

    • PERCENT_35

    PERCENT_35: "pct35"
    +
  • Defined in src/file/shading/shading.ts:64

    • PERCENT_37

    PERCENT_37: "pct37"
    +
  • Defined in src/file/shading/shading.ts:65

    • PERCENT_40

    PERCENT_40: "pct40"
    +
  • Defined in src/file/shading/shading.ts:66

    • PERCENT_45

    PERCENT_45: "pct45"
    +
  • Defined in src/file/shading/shading.ts:67

    • PERCENT_5

    PERCENT_5: "pct5"
    +
  • Defined in src/file/shading/shading.ts:57

    • PERCENT_50

    PERCENT_50: "pct50"
    +
  • Defined in src/file/shading/shading.ts:68

    • PERCENT_55

    PERCENT_55: "pct55"
    +
  • Defined in src/file/shading/shading.ts:69

    • PERCENT_60

    PERCENT_60: "pct60"
    +
  • Defined in src/file/shading/shading.ts:70

    • PERCENT_62

    PERCENT_62: "pct62"
    +
  • Defined in src/file/shading/shading.ts:71

    • PERCENT_65

    PERCENT_65: "pct65"
    +
  • Defined in src/file/shading/shading.ts:72

    • PERCENT_70

    PERCENT_70: "pct70"
    +
  • Defined in src/file/shading/shading.ts:73

    • PERCENT_75

    PERCENT_75: "pct75"
    +
  • Defined in src/file/shading/shading.ts:74

    • PERCENT_80

    PERCENT_80: "pct80"
    +
  • Defined in src/file/shading/shading.ts:75

    • PERCENT_85

    PERCENT_85: "pct85"
    +
  • Defined in src/file/shading/shading.ts:76

    • PERCENT_87

    PERCENT_87: "pct87"
    +
  • Defined in src/file/shading/shading.ts:77

    • PERCENT_90

    PERCENT_90: "pct90"
    +
  • Defined in src/file/shading/shading.ts:78

    • PERCENT_95

    PERCENT_95: "pct95"
    +
  • Defined in src/file/shading/shading.ts:79

    • REVERSE_DIAGONAL_STRIPE

    REVERSE_DIAGONAL_STRIPE: "reverseDiagStripe"
    +
  • Defined in src/file/shading/shading.ts:80

    • SOLID

    SOLID: "solid"
    +
  • Defined in src/file/shading/shading.ts:81

    • THIN_DIAGONAL_CROSS

    THIN_DIAGONAL_CROSS: "thinDiagCross"
    +
  • Defined in src/file/shading/shading.ts:82

    • THIN_DIAGONAL_STRIPE

    THIN_DIAGONAL_STRIPE: "thinDiagStripe"
    +
  • Defined in src/file/shading/shading.ts:83

    • THIN_HORIZONTAL_CROSS

    THIN_HORIZONTAL_CROSS: "thinHorzCross"
    +
  • Defined in src/file/shading/shading.ts:84

    • THIN_REVERSE_DIAGONAL_STRIPE

    THIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe"
    +
  • Defined in src/file/shading/shading.ts:85

    • THIN_VERTICAL_STRIPE

    THIN_VERTICAL_STRIPE: "thinVertStripe"
    +
  • Defined in src/file/shading/shading.ts:86

    • VERTICAL_STRIPE

    VERTICAL_STRIPE: "vertStripe"
    +
  • Defined in src/file/shading/shading.ts:87
    • diff --git a/api/enums/SpaceType.html b/api/enums/SpaceType.html index 291ad1369d..d30f2c5198 100644 --- a/api/enums/SpaceType.html +++ b/api/enums/SpaceType.html @@ -12,7 +12,9 @@ -

    Enumeration SpaceType

    +

    Enumeration SpaceType

    @@ -29,12 +31,12 @@

    DEFAULT

    DEFAULT: "default"
    +
  • Defined in src/file/space-type.ts:2

    • PRESERVE

    PRESERVE: "preserve"
    +
  • Defined in src/file/space-type.ts:3
    • diff --git a/api/enums/TabStopPosition.html b/api/enums/TabStopPosition.html index 0039c98e34..30d26cbc88 100644 --- a/api/enums/TabStopPosition.html +++ b/api/enums/TabStopPosition.html @@ -12,7 +12,9 @@ -

    Enumeration TabStopPosition

    +

    Enumeration TabStopPosition

    @@ -28,7 +30,7 @@

    MAX

    MAX: 9026
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:32
    • diff --git a/api/enums/TabStopType.html b/api/enums/TabStopType.html index cef72e7745..3062a5fc45 100644 --- a/api/enums/TabStopType.html +++ b/api/enums/TabStopType.html @@ -12,7 +12,9 @@ -

    Enumeration TabStopType

    +

    Enumeration TabStopType

    @@ -36,47 +38,47 @@

    BAR

    BAR: "bar"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:15

    • CENTER

    CENTER: "center"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:14

    • CLEAR

    CLEAR: "clear"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:16

    • DECIMAL

    DECIMAL: "decimal"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:17

    • END

    END: "end"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:18

    • LEFT

    LEFT: "left"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:12

    • NUM

    NUM: "num"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:19

    • RIGHT

    RIGHT: "right"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:13

    • START

    START: "start"
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:20
    • diff --git a/api/enums/TableAnchorType.html b/api/enums/TableAnchorType.html index 6265b208b0..50dfd1ecf8 100644 --- a/api/enums/TableAnchorType.html +++ b/api/enums/TableAnchorType.html @@ -12,7 +12,9 @@ -

    Enumeration TableAnchorType

    +

    Enumeration TableAnchorType

    @@ -30,17 +32,17 @@

    MARGIN

    MARGIN: "margin"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:7

    • PAGE

    PAGE: "page"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:8

    • TEXT

    TEXT: "text"
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:9
    • diff --git a/api/enums/TableLayoutType.html b/api/enums/TableLayoutType.html index ef717d39bc..afd15accb4 100644 --- a/api/enums/TableLayoutType.html +++ b/api/enums/TableLayoutType.html @@ -12,7 +12,9 @@ -

    Enumeration TableLayoutType

    +

    Enumeration TableLayoutType

    @@ -29,12 +31,12 @@

    AUTOFIT

    AUTOFIT: "autofit"
    +
  • Defined in src/file/table/table-properties/table-layout.ts:10

    • FIXED

    FIXED: "fixed"
    +
  • Defined in src/file/table/table-properties/table-layout.ts:11
    • diff --git a/api/enums/TextDirection.html b/api/enums/TextDirection.html index 5e2b9d4f0e..32d488859d 100644 --- a/api/enums/TextDirection.html +++ b/api/enums/TextDirection.html @@ -12,7 +12,9 @@ -

    Enumeration TextDirection

    +

    Enumeration TextDirection

    @@ -30,17 +32,17 @@

    BOTTOM_TO_TOP_LEFT_TO_RIGHT

    BOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr"
    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:114

    • LEFT_TO_RIGHT_TOP_TO_BOTTOM

    LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb"
    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:115

    • TOP_TO_BOTTOM_RIGHT_TO_LEFT

    TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl"
    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:116
    • diff --git a/api/enums/TextWrappingSide.html b/api/enums/TextWrappingSide.html index 61cb651e03..23ef04ac85 100644 --- a/api/enums/TextWrappingSide.html +++ b/api/enums/TextWrappingSide.html @@ -12,7 +12,9 @@ -

    Enumeration TextWrappingSide

    +

    Enumeration TextWrappingSide

    @@ -31,22 +33,22 @@

    BOTH_SIDES

    BOTH_SIDES: "bothSides"
    +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:12

    • LARGEST

    LARGEST: "largest"
    +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:15

    • LEFT

    LEFT: "left"
    +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:13

    • RIGHT

    RIGHT: "right"
    +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:14
    • diff --git a/api/enums/TextWrappingType.html b/api/enums/TextWrappingType.html index e02d6bdf92..0e6116d1fc 100644 --- a/api/enums/TextWrappingType.html +++ b/api/enums/TextWrappingType.html @@ -12,7 +12,9 @@ -

    Enumeration TextWrappingType

    +

    Enumeration TextWrappingType

    @@ -31,22 +33,22 @@

    NONE

    NONE: 0
    +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:5

    • SQUARE

    SQUARE: 1
    +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:6

    • TIGHT

    TIGHT: 2
    +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:7

    • TOP_AND_BOTTOM

    TOP_AND_BOTTOM: 3
    +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:8
    • diff --git a/api/enums/UnderlineType.html b/api/enums/UnderlineType.html index 3bc4b0bf48..e12ed2559c 100644 --- a/api/enums/UnderlineType.html +++ b/api/enums/UnderlineType.html @@ -12,7 +12,9 @@ -

    Enumeration UnderlineType

    +

    Enumeration UnderlineType

    @@ -44,87 +46,87 @@

    DASH

    DASH: "dash"
    +
  • Defined in src/file/paragraph/run/underline.ts:11

    • DASHDOTDOTHEAVY

    DASHDOTDOTHEAVY: "dashDotDotHeavy"
    +
  • Defined in src/file/paragraph/run/underline.ts:18

    • DASHDOTHEAVY

    DASHDOTHEAVY: "dashDotHeavy"
    +
  • Defined in src/file/paragraph/run/underline.ts:16

    • DASHEDHEAVY

    DASHEDHEAVY: "dashedHeavy"
    +
  • Defined in src/file/paragraph/run/underline.ts:12

    • DASHLONG

    DASHLONG: "dashLong"
    +
  • Defined in src/file/paragraph/run/underline.ts:13

    • DASHLONGHEAVY

    DASHLONGHEAVY: "dashLongHeavy"
    +
  • Defined in src/file/paragraph/run/underline.ts:14

    • DOTDASH

    DOTDASH: "dotDash"
    +
  • Defined in src/file/paragraph/run/underline.ts:15

    • DOTDOTDASH

    DOTDOTDASH: "dotDotDash"
    +
  • Defined in src/file/paragraph/run/underline.ts:17

    • DOTTED

    DOTTED: "dotted"
    +
  • Defined in src/file/paragraph/run/underline.ts:9

    • DOTTEDHEAVY

    DOTTEDHEAVY: "dottedHeavy"
    +
  • Defined in src/file/paragraph/run/underline.ts:10

    • DOUBLE

    DOUBLE: "double"
    +
  • Defined in src/file/paragraph/run/underline.ts:7

    • SINGLE

    SINGLE: "single"
    +
  • Defined in src/file/paragraph/run/underline.ts:5

    • THICK

    THICK: "thick"
    +
  • Defined in src/file/paragraph/run/underline.ts:8

    • WAVE

    WAVE: "wave"
    +
  • Defined in src/file/paragraph/run/underline.ts:19

    • WAVYDOUBLE

    WAVYDOUBLE: "wavyDouble"
    +
  • Defined in src/file/paragraph/run/underline.ts:21

    • WAVYHEAVY

    WAVYHEAVY: "wavyHeavy"
    +
  • Defined in src/file/paragraph/run/underline.ts:20

    • WORDS

    WORDS: "words"
    +
  • Defined in src/file/paragraph/run/underline.ts:6
    • diff --git a/api/enums/VerticalAlign.html b/api/enums/VerticalAlign.html index 4deb1b2403..343b4cba82 100644 --- a/api/enums/VerticalAlign.html +++ b/api/enums/VerticalAlign.html @@ -12,7 +12,9 @@ -

    Enumeration VerticalAlign

    +

    Enumeration VerticalAlign

    @@ -30,17 +32,17 @@

    BOTTOM

    BOTTOM: "bottom"
    +
  • Defined in src/file/vertical-align/vertical-align.ts:15

    • CENTER

    CENTER: "center"
    +
  • Defined in src/file/vertical-align/vertical-align.ts:16

    • TOP

    TOP: "top"
    +
  • Defined in src/file/vertical-align/vertical-align.ts:17
    • diff --git a/api/enums/VerticalMergeType.html b/api/enums/VerticalMergeType.html index 07eaf07f55..fbeef58ab2 100644 --- a/api/enums/VerticalMergeType.html +++ b/api/enums/VerticalMergeType.html @@ -15,7 +15,9 @@

    Enumeration VerticalMergeType

    Vertical merge types.

    -
    +
    @@ -34,14 +36,14 @@

    Cell that is merged with upper one.

    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:87

    • RESTART

    RESTART: "restart"

    Cell that is starting the vertical merge.

    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:91
    • diff --git a/api/enums/VerticalPositionAlign.html b/api/enums/VerticalPositionAlign.html index 18632fc81c..801860a04a 100644 --- a/api/enums/VerticalPositionAlign.html +++ b/api/enums/VerticalPositionAlign.html @@ -12,7 +12,9 @@ -

    Enumeration VerticalPositionAlign

    +

    Enumeration VerticalPositionAlign

    @@ -32,27 +34,27 @@

    BOTTOM

    BOTTOM: "bottom"
    +
  • Defined in src/file/shared/alignment.ts:10

    • CENTER

    CENTER: "center"
    +
  • Defined in src/file/shared/alignment.ts:11

    • INSIDE

    INSIDE: "inside"
    +
  • Defined in src/file/shared/alignment.ts:12

    • OUTSIDE

    OUTSIDE: "outside"
    +
  • Defined in src/file/shared/alignment.ts:13

    • TOP

    TOP: "top"
    +
  • Defined in src/file/shared/alignment.ts:14
    • diff --git a/api/enums/VerticalPositionRelativeFrom.html b/api/enums/VerticalPositionRelativeFrom.html index 959add596d..d9afbb0360 100644 --- a/api/enums/VerticalPositionRelativeFrom.html +++ b/api/enums/VerticalPositionRelativeFrom.html @@ -12,7 +12,9 @@ -

    Enumeration VerticalPositionRelativeFrom

    +

    Enumeration VerticalPositionRelativeFrom

    @@ -35,42 +37,42 @@

    BOTTOM_MARGIN

    BOTTOM_MARGIN: "bottomMargin"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:19

    • INSIDE_MARGIN

    INSIDE_MARGIN: "insideMargin"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:20

    • LINE

    LINE: "line"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:21

    • MARGIN

    MARGIN: "margin"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:22

    • OUTSIDE_MARGIN

    OUTSIDE_MARGIN: "outsideMargin"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:23

    • PAGE

    PAGE: "page"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:24

    • PARAGRAPH

    PARAGRAPH: "paragraph"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:25

    • TOP_MARGIN

    TOP_MARGIN: "topMargin"
    +
  • Defined in src/file/drawing/floating/floating-position.ts:26
    • diff --git a/api/enums/WidthType.html b/api/enums/WidthType.html index d99aa8fd99..11a830c7da 100644 --- a/api/enums/WidthType.html +++ b/api/enums/WidthType.html @@ -12,7 +12,9 @@ -

    Enumeration WidthType

    +

    Enumeration WidthType

    @@ -33,28 +35,28 @@

    Auto.

    +
  • Defined in src/file/table/table-width.ts:15

    • DXA

    DXA: "dxa"

    Value is in twentieths of a point

    +
  • Defined in src/file/table/table-width.ts:17

    • NIL

    NIL: "nil"

    No (empty) value.

    +
  • Defined in src/file/table/table-width.ts:19

    • PERCENTAGE

    PERCENTAGE: "pct"

    Value is in percentage.

    +
  • Defined in src/file/table/table-width.ts:21
    • diff --git a/api/functions/convertInchesToTwip.html b/api/functions/convertInchesToTwip.html index 158fef755a..f3cbecb8c4 100644 --- a/api/functions/convertInchesToTwip.html +++ b/api/functions/convertInchesToTwip.html @@ -22,7 +22,9 @@
    • inches: number
    -

    Returns number

    +

    Returns number

    diff --git a/api/functions/convertMillimetersToTwip.html b/api/functions/convertMillimetersToTwip.html index 4471a920b7..0cd7a43d84 100644 --- a/api/functions/convertMillimetersToTwip.html +++ b/api/functions/convertMillimetersToTwip.html @@ -22,7 +22,9 @@
    • millimeters: number
    -

    Returns number

    +

    Returns number

    diff --git a/api/functions/convertToXmlComponent.html b/api/functions/convertToXmlComponent.html index 9acf590f35..e6e33221b7 100644 --- a/api/functions/convertToXmlComponent.html +++ b/api/functions/convertToXmlComponent.html @@ -26,7 +26,9 @@
    element: Element

    the xml element in json presentation

    -

    Returns ImportedXmlComponent | string | undefined

    +

    Returns ImportedXmlComponent | string | undefined

    diff --git a/api/functions/dateTimeValue.html b/api/functions/dateTimeValue.html index 1e081c1441..da49f82451 100644 --- a/api/functions/dateTimeValue.html +++ b/api/functions/dateTimeValue.html @@ -22,7 +22,9 @@
    • val: Date
    -

    Returns string

    +

    Returns string

    diff --git a/api/functions/decimalNumber.html b/api/functions/decimalNumber.html index 6afc865951..004f181d28 100644 --- a/api/functions/decimalNumber.html +++ b/api/functions/decimalNumber.html @@ -22,7 +22,9 @@
    • val: number
    -

    Returns number

    +

    Returns number

    diff --git a/api/functions/eighthPointMeasureValue.html b/api/functions/eighthPointMeasureValue.html index df5a1935aa..7fef62012c 100644 --- a/api/functions/eighthPointMeasureValue.html +++ b/api/functions/eighthPointMeasureValue.html @@ -22,7 +22,9 @@
    • val: number
    -

    Returns number

    +

    Returns number

    diff --git a/api/functions/hexColorValue.html b/api/functions/hexColorValue.html index 5ff6ea1fa6..b4f3e74b67 100644 --- a/api/functions/hexColorValue.html +++ b/api/functions/hexColorValue.html @@ -22,7 +22,9 @@
    • val: string
    -

    Returns string

    +

    Returns string

    diff --git a/api/functions/hpsMeasureValue.html b/api/functions/hpsMeasureValue.html index 1638530eb9..bc8bffe702 100644 --- a/api/functions/hpsMeasureValue.html +++ b/api/functions/hpsMeasureValue.html @@ -22,7 +22,9 @@
    • val: string | number
    -

    Returns string | number

    +

    Returns string | number

    diff --git a/api/functions/longHexNumber.html b/api/functions/longHexNumber.html index 2b68bd44fc..37aa700c29 100644 --- a/api/functions/longHexNumber.html +++ b/api/functions/longHexNumber.html @@ -22,7 +22,9 @@
    • val: string
    -

    Returns string

    +

    Returns string

    diff --git a/api/functions/measurementOrPercentValue.html b/api/functions/measurementOrPercentValue.html index b38243f1f8..3270f28c6b 100644 --- a/api/functions/measurementOrPercentValue.html +++ b/api/functions/measurementOrPercentValue.html @@ -22,7 +22,9 @@
    • val: string | number
    -

    Returns number | string

    +

    Returns number | string

    diff --git a/api/functions/percentageValue.html b/api/functions/percentageValue.html index c3e73cdf86..f7a998933c 100644 --- a/api/functions/percentageValue.html +++ b/api/functions/percentageValue.html @@ -22,7 +22,9 @@
    • val: string
    -

    Returns string

    +

    Returns string

    diff --git a/api/functions/pointMeasureValue.html b/api/functions/pointMeasureValue.html index e4b8993569..7dfe074c23 100644 --- a/api/functions/pointMeasureValue.html +++ b/api/functions/pointMeasureValue.html @@ -22,7 +22,9 @@
    • val: number
    -

    Returns number

    +

    Returns number

    diff --git a/api/functions/positiveUniversalMeasureValue.html b/api/functions/positiveUniversalMeasureValue.html index dbcbdd0328..09eebcf8c4 100644 --- a/api/functions/positiveUniversalMeasureValue.html +++ b/api/functions/positiveUniversalMeasureValue.html @@ -22,7 +22,9 @@
    • val: string
    -

    Returns string

    +

    Returns string

    diff --git a/api/functions/shortHexNumber.html b/api/functions/shortHexNumber.html index ea06b1ee90..6823f1ac31 100644 --- a/api/functions/shortHexNumber.html +++ b/api/functions/shortHexNumber.html @@ -22,7 +22,9 @@
    • val: string
    -

    Returns string

    +

    Returns string

    diff --git a/api/functions/signedHpsMeasureValue.html b/api/functions/signedHpsMeasureValue.html index a543aa46db..44cc1f14d4 100644 --- a/api/functions/signedHpsMeasureValue.html +++ b/api/functions/signedHpsMeasureValue.html @@ -22,7 +22,9 @@
    • val: string | number
    -

    Returns string | number

    +

    Returns string | number

    diff --git a/api/functions/signedTwipsMeasureValue.html b/api/functions/signedTwipsMeasureValue.html index 87de5b70fa..d3ba7cd274 100644 --- a/api/functions/signedTwipsMeasureValue.html +++ b/api/functions/signedTwipsMeasureValue.html @@ -22,7 +22,9 @@
    • val: string | number
    -

    Returns string | number

    +

    Returns string | number

    diff --git a/api/functions/twipsMeasureValue.html b/api/functions/twipsMeasureValue.html index 83e45d2584..4c02367405 100644 --- a/api/functions/twipsMeasureValue.html +++ b/api/functions/twipsMeasureValue.html @@ -22,7 +22,9 @@
    • val: string | number
    -

    Returns string | number

    +

    Returns string | number

    diff --git a/api/functions/uCharHexNumber.html b/api/functions/uCharHexNumber.html index eeabf446cb..59b321e63c 100644 --- a/api/functions/uCharHexNumber.html +++ b/api/functions/uCharHexNumber.html @@ -22,7 +22,9 @@
    • val: string
    -

    Returns string

    +

    Returns string

    diff --git a/api/functions/uniqueId.html b/api/functions/uniqueId.html index 84e00593e6..8cbdc433a2 100644 --- a/api/functions/uniqueId.html +++ b/api/functions/uniqueId.html @@ -17,7 +17,9 @@
    • -

      Returns string

    +

    Returns string

    diff --git a/api/functions/uniqueNumericId.html b/api/functions/uniqueNumericId.html index 8fedb70dc9..e729df66b3 100644 --- a/api/functions/uniqueNumericId.html +++ b/api/functions/uniqueNumericId.html @@ -17,7 +17,9 @@
    • -

      Returns number

    +

    Returns number

    diff --git a/api/functions/universalMeasureValue.html b/api/functions/universalMeasureValue.html index 5716f78e0b..3020a30496 100644 --- a/api/functions/universalMeasureValue.html +++ b/api/functions/universalMeasureValue.html @@ -22,7 +22,9 @@
    • val: string
    -

    Returns string

    +

    Returns string

    diff --git a/api/functions/unsignedDecimalNumber.html b/api/functions/unsignedDecimalNumber.html index 92798bd2a2..7fbe2057ae 100644 --- a/api/functions/unsignedDecimalNumber.html +++ b/api/functions/unsignedDecimalNumber.html @@ -22,7 +22,9 @@
    • val: number
    -

    Returns number

    +

    Returns number

    diff --git a/api/interfaces/IAlignmentFrameOptions.html b/api/interfaces/IAlignmentFrameOptions.html index 67cf1b8338..3c809a7007 100644 --- a/api/interfaces/IAlignmentFrameOptions.html +++ b/api/interfaces/IAlignmentFrameOptions.html @@ -18,7 +18,9 @@
    • IBaseFrameOptions
        -
      • IAlignmentFrameOptions
    +
  • IAlignmentFrameOptions
    • @@ -50,7 +52,7 @@
  • Readonly y: VerticalPositionAlign
    • +
  • Defined in src/file/paragraph/frame/frame-properties.ts:53

    • Readonly anchor

    anchor: { horizontal: FrameAnchorType; vertical: FrameAnchorType }
    @@ -63,37 +65,37 @@
    Readonly vertical: FrameAnchorType
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:34

    • Optional Readonly anchorLock

    anchorLock?: boolean
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:28

    • Optional Readonly dropCap

    dropCap?: DropCapType
    +
  • 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

    • Optional Readonly rule

    rule?: HeightRule
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:42

    • Optional Readonly space

    space?: { horizontal: number; vertical: number }
    @@ -106,19 +108,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

    • Optional Readonly wrap

    wrap?: FrameWrap
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:32
    • diff --git a/api/interfaces/IBaseCharacterStyleOptions.html b/api/interfaces/IBaseCharacterStyleOptions.html index 8d90502641..44ef598819 100644 --- a/api/interfaces/IBaseCharacterStyleOptions.html +++ b/api/interfaces/IBaseCharacterStyleOptions.html @@ -20,7 +20,9 @@ +
  • ICharacterStyleOptions
    • @@ -45,54 +47,54 @@
    basedOn?: string
    +
  • Defined in src/file/styles/style/style.ts:44

    • Optional Readonly link

    link?: string
    +
  • Defined in src/file/styles/style/style.ts:46

    • Optional Readonly name

    name?: string
    +
  • Defined in src/file/styles/style/style.ts:43

    • Optional Readonly next

    next?: string
    +
  • Defined in src/file/styles/style/style.ts:45

    • Optional Readonly quickFormat

    quickFormat?: boolean
    +
  • Defined in src/file/styles/style/style.ts:50

    • Optional Readonly run

    run?: IRunStylePropertiesOptions
    +
  • Defined in src/file/styles/style/character-style.ts:6

    • Optional Readonly semiHidden

    semiHidden?: boolean
    +
  • Defined in src/file/styles/style/style.ts:48

    • Optional Readonly uiPriority

    uiPriority?: number
    +
  • Defined in src/file/styles/style/style.ts:47

    • Optional Readonly unhideWhenUsed

    unhideWhenUsed?: boolean
    +
  • Defined in src/file/styles/style/style.ts:49
    • diff --git a/api/interfaces/IBaseParagraphStyleOptions.html b/api/interfaces/IBaseParagraphStyleOptions.html index b5b4250867..45142def19 100644 --- a/api/interfaces/IBaseParagraphStyleOptions.html +++ b/api/interfaces/IBaseParagraphStyleOptions.html @@ -20,7 +20,9 @@ +
  • IParagraphStyleOptions
    • @@ -46,59 +48,59 @@
    basedOn?: string
    +
  • Defined in src/file/styles/style/style.ts:44

    • Optional Readonly link

    link?: string
    +
  • Defined in src/file/styles/style/style.ts:46

    • Optional Readonly name

    name?: string
    +
  • Defined in src/file/styles/style/style.ts:43

    • Optional Readonly next

    next?: string
    +
  • Defined in src/file/styles/style/style.ts:45

    • Optional Readonly paragraph

    paragraph?: IParagraphStylePropertiesOptions
    +
  • Defined in src/file/styles/style/paragraph-style.ts:6

    • Optional Readonly quickFormat

    quickFormat?: boolean
    +
  • Defined in src/file/styles/style/style.ts:50

    • Optional Readonly run

    run?: IRunStylePropertiesOptions
    +
  • Defined in src/file/styles/style/paragraph-style.ts:7

    • Optional Readonly semiHidden

    semiHidden?: boolean
    +
  • Defined in src/file/styles/style/style.ts:48

    • Optional Readonly uiPriority

    uiPriority?: number
    +
  • Defined in src/file/styles/style/style.ts:47

    • Optional Readonly unhideWhenUsed

    unhideWhenUsed?: boolean
    +
  • Defined in src/file/styles/style/style.ts:49
    • diff --git a/api/interfaces/IBorderOptions.html b/api/interfaces/IBorderOptions.html index 9cbd9774cc..c97d262376 100644 --- a/api/interfaces/IBorderOptions.html +++ b/api/interfaces/IBorderOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IBorderOptions
    +
  • IBorderOptions
    • @@ -37,26 +39,26 @@

    Border color, in hex (eg 'FF00AA')

    +
  • Defined in src/file/border/border.ts:28

    • Optional Readonly size

    size?: number

    Size of the border in 1/8 pt

    +
  • Defined in src/file/border/border.ts:30

    • Optional Readonly space

    space?: number

    Spacing offset. Values are specified in pt

    +
  • Defined in src/file/border/border.ts:32

    • Readonly style

    style: BorderStyle
    +
  • Defined in src/file/border/border.ts:26
    • diff --git a/api/interfaces/IBordersOptions.html b/api/interfaces/IBordersOptions.html index 59d666edc4..51c15cfe25 100644 --- a/api/interfaces/IBordersOptions.html +++ b/api/interfaces/IBordersOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IBordersOptions
    +
  • IBordersOptions
    • @@ -35,22 +37,22 @@

    Optional Readonly bottom

    bottom?: IBorderOptions
    +
  • Defined in src/file/paragraph/formatting/border.ts:7

    • Optional Readonly left

    left?: IBorderOptions
    +
  • Defined in src/file/paragraph/formatting/border.ts:8

    • Optional Readonly right

    right?: IBorderOptions
    +
  • Defined in src/file/paragraph/formatting/border.ts:9

    • Optional Readonly top

    top?: IBorderOptions
    +
  • Defined in src/file/paragraph/formatting/border.ts:6
    • diff --git a/api/interfaces/ICharacterStyleOptions.html b/api/interfaces/ICharacterStyleOptions.html index 0586e053fa..1322138b86 100644 --- a/api/interfaces/ICharacterStyleOptions.html +++ b/api/interfaces/ICharacterStyleOptions.html @@ -18,7 +18,9 @@ +
  • ICharacterStyleOptions
    • @@ -44,60 +46,60 @@
    basedOn?: string
    +
  • Defined in src/file/styles/style/style.ts:44

    • Readonly id

    id: string
    +
  • Defined in src/file/styles/style/character-style.ts:10

    • Optional Readonly link

    link?: string
    +
  • Defined in src/file/styles/style/style.ts:46

    • Optional Readonly name

    name?: string
    +
  • Defined in src/file/styles/style/character-style.ts:11

    • Optional Readonly next

    next?: string
    +
  • Defined in src/file/styles/style/style.ts:45

    • Optional Readonly quickFormat

    quickFormat?: boolean
    +
  • Defined in src/file/styles/style/style.ts:50

    • Optional Readonly run

    run?: IRunStylePropertiesOptions
    +
  • Defined in src/file/styles/style/character-style.ts:6

    • Optional Readonly semiHidden

    semiHidden?: boolean
    +
  • Defined in src/file/styles/style/style.ts:48

    • Optional Readonly uiPriority

    uiPriority?: number
    +
  • Defined in src/file/styles/style/style.ts:47

    • Optional Readonly unhideWhenUsed

    unhideWhenUsed?: boolean
    +
  • Defined in src/file/styles/style/style.ts:49
    • diff --git a/api/interfaces/IColumnAttributes.html b/api/interfaces/IColumnAttributes.html index aaa6675e23..49b612693b 100644 --- a/api/interfaces/IColumnAttributes.html +++ b/api/interfaces/IColumnAttributes.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IColumnAttributes
    +
  • IColumnAttributes
    • @@ -33,12 +35,12 @@

    Optional Readonly space

    space?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/column.ts:6

    • Readonly width

    width: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/column.ts:5
    • diff --git a/api/interfaces/IColumnsAttributes.html b/api/interfaces/IColumnsAttributes.html index 6f5d59cb6a..3c6fe30ad0 100644 --- a/api/interfaces/IColumnsAttributes.html +++ b/api/interfaces/IColumnsAttributes.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IColumnsAttributes
    +
  • IColumnsAttributes
    • @@ -36,27 +38,27 @@

    Optional Readonly children

    children?: Column[]
    +
  • Defined in src/file/document/body/section-properties/properties/columns.ts:20

    • Optional Readonly count

    count?: number
    +
  • Defined in src/file/document/body/section-properties/properties/columns.ts:17

    • Optional Readonly equalWidth

    equalWidth?: boolean
    +
  • Defined in src/file/document/body/section-properties/properties/columns.ts:19

    • Optional Readonly separate

    separate?: boolean
    +
  • Defined in src/file/document/body/section-properties/properties/columns.ts:18

    • Optional Readonly space

    space?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/columns.ts:16
    • diff --git a/api/interfaces/ICommentOptions.html b/api/interfaces/ICommentOptions.html index 1d3d4c5a89..dfa96287b7 100644 --- a/api/interfaces/ICommentOptions.html +++ b/api/interfaces/ICommentOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ICommentOptions
    +
  • ICommentOptions
    • @@ -36,27 +38,27 @@

    Optional Readonly author

    author?: string
    +
  • Defined in src/file/paragraph/run/comment-run.ts:10

    • Optional Readonly date

    date?: Date
    +
  • Defined in src/file/paragraph/run/comment-run.ts:11

    • Readonly id

    id: number
    +
  • Defined in src/file/paragraph/run/comment-run.ts:7

    • Optional Readonly initials

    initials?: string
    +
  • Defined in src/file/paragraph/run/comment-run.ts:9

    • Readonly text

    text: string
    +
  • Defined in src/file/paragraph/run/comment-run.ts:8
    • diff --git a/api/interfaces/ICommentsOptions.html b/api/interfaces/ICommentsOptions.html index d0da86aa32..f7d08e802a 100644 --- a/api/interfaces/ICommentsOptions.html +++ b/api/interfaces/ICommentsOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ICommentsOptions
    +
  • ICommentsOptions
    • @@ -32,7 +34,7 @@

    Readonly children

    children: ICommentOptions[]
    +
  • Defined in src/file/paragraph/run/comment-run.ts:15
    • diff --git a/api/interfaces/IConcreteNumberingOptions.html b/api/interfaces/IConcreteNumberingOptions.html index 710ae4e87f..ed4b64ea53 100644 --- a/api/interfaces/IConcreteNumberingOptions.html +++ b/api/interfaces/IConcreteNumberingOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IConcreteNumberingOptions
    +
  • IConcreteNumberingOptions
    • @@ -36,17 +38,17 @@

    Readonly abstractNumId

    abstractNumId: number
    +
  • Defined in src/file/numbering/num.ts:23

    • Readonly instance

    instance: number
    +
  • Defined in src/file/numbering/num.ts:25

    • Readonly numId

    numId: number
    +
  • Defined in src/file/numbering/num.ts:22

    • Optional Readonly overrideLevel

    overrideLevel?: { num: number; start?: number }
    @@ -58,12 +60,12 @@
  • Optional Readonly start?: number
    • +
  • Defined in src/file/numbering/num.ts:26

    • Readonly reference

    reference: string
    +
  • Defined in src/file/numbering/num.ts:24
    • diff --git a/api/interfaces/IContext.html b/api/interfaces/IContext.html index df6243c7b3..a376424234 100644 --- a/api/interfaces/IContext.html +++ b/api/interfaces/IContext.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IContext
    +
  • IContext
    • @@ -33,12 +35,12 @@

    Readonly file

    file: Document
    +
  • Defined in src/file/xml-components/base.ts:6

    • Readonly viewWrapper

    viewWrapper: IViewWrapper
    +
  • Defined in src/file/xml-components/base.ts:7
    • diff --git a/api/interfaces/IDistance.html b/api/interfaces/IDistance.html index 7aeed3a441..ac1882adf4 100644 --- a/api/interfaces/IDistance.html +++ b/api/interfaces/IDistance.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IDistance
    +
  • IDistance
    • @@ -35,22 +37,22 @@

    Optional Readonly distB

    distB?: number
    +
  • Defined in src/file/drawing/drawing.ts:9

    • Optional Readonly distL

    distL?: number
    +
  • Defined in src/file/drawing/drawing.ts:10

    • Optional Readonly distR

    distR?: number
    +
  • Defined in src/file/drawing/drawing.ts:11

    • Optional Readonly distT

    distT?: number
    +
  • Defined in src/file/drawing/drawing.ts:8
    • diff --git a/api/interfaces/IDocGridAttributesProperties.html b/api/interfaces/IDocGridAttributesProperties.html index 65e7c0d3b4..df4fb989c4 100644 --- a/api/interfaces/IDocGridAttributesProperties.html +++ b/api/interfaces/IDocGridAttributesProperties.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IDocGridAttributesProperties
    +
  • IDocGridAttributesProperties
    • @@ -34,17 +36,17 @@

    Optional Readonly charSpace

    charSpace?: number
    +
  • Defined in src/file/document/body/section-properties/properties/doc-grid.ts:29

    • Optional Readonly linePitch

    linePitch?: number
    +
  • Defined in src/file/document/body/section-properties/properties/doc-grid.ts:28

    • Optional Readonly type

    type?: DocumentGridType
    +
  • Defined in src/file/document/body/section-properties/properties/doc-grid.ts:27
    • diff --git a/api/interfaces/IDocumentAttributesProperties.html b/api/interfaces/IDocumentAttributesProperties.html index 281b3066d1..708b7391a4 100644 --- a/api/interfaces/IDocumentAttributesProperties.html +++ b/api/interfaces/IDocumentAttributesProperties.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IDocumentAttributesProperties
    +
  • IDocumentAttributesProperties
    • @@ -70,197 +72,197 @@

    Optional Readonly Ignorable

    Ignorable?: string
    +
  • Defined in src/file/document/document-attributes.ts:21

    • Optional Readonly aink

    aink?: string
    +
  • Defined in src/file/document/document-attributes.ts:37

    • Optional Readonly am3d

    am3d?: string
    +
  • Defined in src/file/document/document-attributes.ts:38

    • Optional Readonly cp

    cp?: string
    +
  • Defined in src/file/document/document-attributes.ts:22

    • Optional Readonly cx

    cx?: string
    +
  • Defined in src/file/document/document-attributes.ts:28

    • Optional Readonly cx1

    cx1?: string
    +
  • Defined in src/file/document/document-attributes.ts:29

    • Optional Readonly cx2

    cx2?: string
    +
  • Defined in src/file/document/document-attributes.ts:30

    • Optional Readonly cx3

    cx3?: string
    +
  • Defined in src/file/document/document-attributes.ts:31

    • Optional Readonly cx4

    cx4?: string
    +
  • Defined in src/file/document/document-attributes.ts:32

    • Optional Readonly cx5

    cx5?: string
    +
  • Defined in src/file/document/document-attributes.ts:33

    • Optional Readonly cx6

    cx6?: string
    +
  • Defined in src/file/document/document-attributes.ts:34

    • Optional Readonly cx7

    cx7?: string
    +
  • Defined in src/file/document/document-attributes.ts:35

    • Optional Readonly cx8

    cx8?: string
    +
  • Defined in src/file/document/document-attributes.ts:36

    • Optional Readonly dc

    dc?: string
    +
  • Defined in src/file/document/document-attributes.ts:23

    • Optional Readonly dcmitype

    dcmitype?: string
    +
  • Defined in src/file/document/document-attributes.ts:25

    • Optional Readonly dcterms

    dcterms?: string
    +
  • Defined in src/file/document/document-attributes.ts:24

    • Optional Readonly m

    m?: string
    +
  • Defined in src/file/document/document-attributes.ts:9

    • Optional Readonly mc

    mc?: string
    +
  • Defined in src/file/document/document-attributes.ts:6

    • Optional Readonly o

    o?: string
    +
  • Defined in src/file/document/document-attributes.ts:7

    • Optional Readonly r

    r?: string
    +
  • Defined in src/file/document/document-attributes.ts:8

    • Optional Readonly type

    type?: string
    +
  • Defined in src/file/document/document-attributes.ts:27

    • Optional Readonly v

    v?: string
    +
  • Defined in src/file/document/document-attributes.ts:10

    • Optional Readonly w

    w?: string
    +
  • Defined in src/file/document/document-attributes.ts:14

    • Optional Readonly w10

    w10?: string
    +
  • Defined in src/file/document/document-attributes.ts:13

    • Optional Readonly w14

    w14?: string
    +
  • Defined in src/file/document/document-attributes.ts:15

    • Optional Readonly w15

    w15?: string
    +
  • Defined in src/file/document/document-attributes.ts:16

    • Optional Readonly w16

    w16?: string
    +
  • Defined in src/file/document/document-attributes.ts:41

    • Optional Readonly w16cex

    w16cex?: string
    +
  • Defined in src/file/document/document-attributes.ts:39

    • Optional Readonly w16cid

    w16cid?: string
    +
  • Defined in src/file/document/document-attributes.ts:40

    • Optional Readonly w16sdtdh

    w16sdtdh?: string
    +
  • Defined in src/file/document/document-attributes.ts:42

    • Optional Readonly w16se

    w16se?: string
    +
  • Defined in src/file/document/document-attributes.ts:43

    • Optional Readonly wne

    wne?: string
    +
  • Defined in src/file/document/document-attributes.ts:19

    • Optional Readonly wp

    wp?: string
    +
  • Defined in src/file/document/document-attributes.ts:12

    • Optional Readonly wp14

    wp14?: string
    +
  • Defined in src/file/document/document-attributes.ts:11

    • Optional Readonly wpc

    wpc?: string
    +
  • Defined in src/file/document/document-attributes.ts:5

    • Optional Readonly wpg

    wpg?: string
    +
  • Defined in src/file/document/document-attributes.ts:17

    • Optional Readonly wpi

    wpi?: string
    +
  • Defined in src/file/document/document-attributes.ts:18

    • Optional Readonly wps

    wps?: string
    +
  • Defined in src/file/document/document-attributes.ts:20

    • Optional Readonly xsi

    xsi?: string
    +
  • Defined in src/file/document/document-attributes.ts:26
    • diff --git a/api/interfaces/IDocumentBackgroundOptions.html b/api/interfaces/IDocumentBackgroundOptions.html index 4e48502be6..128d611d24 100644 --- a/api/interfaces/IDocumentBackgroundOptions.html +++ b/api/interfaces/IDocumentBackgroundOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IDocumentBackgroundOptions
    +
  • IDocumentBackgroundOptions
    • @@ -35,22 +37,22 @@

    Optional Readonly color

    color?: string
    +
  • Defined in src/file/document/document-background/document-background.ts:43

    • Optional Readonly themeColor

    themeColor?: string
    +
  • Defined in src/file/document/document-background/document-background.ts:44

    • Optional Readonly themeShade

    themeShade?: string
    +
  • Defined in src/file/document/document-background/document-background.ts:45

    • Optional Readonly themeTint

    themeTint?: string
    +
  • Defined in src/file/document/document-background/document-background.ts:46
    • diff --git a/api/interfaces/IDocumentDefaultsOptions.html b/api/interfaces/IDocumentDefaultsOptions.html index 83c430e78b..384b3650b9 100644 --- a/api/interfaces/IDocumentDefaultsOptions.html +++ b/api/interfaces/IDocumentDefaultsOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IDocumentDefaultsOptions
    +
  • IDocumentDefaultsOptions
    • @@ -33,12 +35,12 @@

    Optional Readonly paragraph

    paragraph?: IParagraphStylePropertiesOptions
    +
  • Defined in src/file/styles/defaults/document-defaults.ts:8

    • Optional Readonly run

    run?: IRunStylePropertiesOptions
    +
  • Defined in src/file/styles/defaults/document-defaults.ts:9
    • diff --git a/api/interfaces/IDocumentFooter.html b/api/interfaces/IDocumentFooter.html index 05f861428b..27a886b48e 100644 --- a/api/interfaces/IDocumentFooter.html +++ b/api/interfaces/IDocumentFooter.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IDocumentFooter
    +
  • IDocumentFooter
    • @@ -33,12 +35,12 @@

    Readonly footer

    footer: FooterWrapper
    +
  • Defined in src/file/footer-wrapper.ts:12

    • Readonly type

    type: HeaderFooterReferenceType
    +
  • Defined in src/file/footer-wrapper.ts:13
    • diff --git a/api/interfaces/IDocumentHeader.html b/api/interfaces/IDocumentHeader.html index 16e7e6fe0a..e6a6558e10 100644 --- a/api/interfaces/IDocumentHeader.html +++ b/api/interfaces/IDocumentHeader.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IDocumentHeader
    +
  • IDocumentHeader
    • @@ -33,12 +35,12 @@

    Readonly header

    header: HeaderWrapper
    +
  • Defined in src/file/header-wrapper.ts:12

    • Readonly type

    type: HeaderFooterReferenceType
    +
  • Defined in src/file/header-wrapper.ts:13
    • diff --git a/api/interfaces/IDocumentOptions.html b/api/interfaces/IDocumentOptions.html index 1b3f482402..fac88ceeeb 100644 --- a/api/interfaces/IDocumentOptions.html +++ b/api/interfaces/IDocumentOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IDocumentOptions
    +
  • IDocumentOptions
    • @@ -32,7 +34,7 @@

    Readonly background

    background: IDocumentBackgroundOptions
    +
  • Defined in src/file/document/document.ts:11
    • diff --git a/api/interfaces/IDocumentTemplate.html b/api/interfaces/IDocumentTemplate.html index 4284b4c807..f5936337bb 100644 --- a/api/interfaces/IDocumentTemplate.html +++ b/api/interfaces/IDocumentTemplate.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IDocumentTemplate
    +
  • IDocumentTemplate
    • @@ -37,32 +39,32 @@

    Readonly currentRelationshipId

    currentRelationshipId: number
    +
  • Defined in src/import-dotx/import-dotx.ts:39

    • Readonly footers

    footers: IDocumentFooter[]
    +
  • Defined in src/import-dotx/import-dotx.ts:41

    • Readonly headers

    headers: IDocumentHeader[]
    +
  • Defined in src/import-dotx/import-dotx.ts:40

    • Readonly media

    media: Media
    +
  • Defined in src/import-dotx/import-dotx.ts:44

    • Readonly styles

    styles: string
    +
  • Defined in src/import-dotx/import-dotx.ts:42

    • Readonly titlePageIsDefined

    titlePageIsDefined: boolean
    +
  • Defined in src/import-dotx/import-dotx.ts:43
    • diff --git a/api/interfaces/IDrawingOptions.html b/api/interfaces/IDrawingOptions.html index c3628d733e..f0ac14cebd 100644 --- a/api/interfaces/IDrawingOptions.html +++ b/api/interfaces/IDrawingOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IDrawingOptions
    +
  • IDrawingOptions
    • @@ -32,7 +34,7 @@

    Optional Readonly floating

    floating?: IFloating
    +
  • Defined in src/file/drawing/drawing.ts:15
    • diff --git a/api/interfaces/IFileProperties.html b/api/interfaces/IFileProperties.html index e97cadb5f5..26f839e32e 100644 --- a/api/interfaces/IFileProperties.html +++ b/api/interfaces/IFileProperties.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IFileProperties
    +
  • IFileProperties
    • @@ -32,7 +34,7 @@

    Optional Readonly template

    template?: IDocumentTemplate
    +
  • Defined in src/file/file-properties.ts:4
    • diff --git a/api/interfaces/IFloating.html b/api/interfaces/IFloating.html index 99fc901a3e..4cce9f8189 100644 --- a/api/interfaces/IFloating.html +++ b/api/interfaces/IFloating.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IFloating
    +
  • IFloating
    • @@ -40,47 +42,47 @@

    Optional Readonly allowOverlap

    allowOverlap?: boolean
    +
  • Defined in src/file/drawing/floating/floating-position.ts:51

    • Optional Readonly behindDocument

    behindDocument?: boolean
    +
  • Defined in src/file/drawing/floating/floating-position.ts:53

    • Readonly horizontalPosition

    horizontalPosition: IHorizontalPositionOptions
    +
  • Defined in src/file/drawing/floating/floating-position.ts:49

    • Optional Readonly layoutInCell

    layoutInCell?: boolean
    +
  • Defined in src/file/drawing/floating/floating-position.ts:54

    • Optional Readonly lockAnchor

    lockAnchor?: boolean
    +
  • Defined in src/file/drawing/floating/floating-position.ts:52

    • Optional Readonly margins

    margins?: IMargins
    +
  • Defined in src/file/drawing/floating/floating-position.ts:55

    • Readonly verticalPosition

    verticalPosition: IVerticalPositionOptions
    +
  • Defined in src/file/drawing/floating/floating-position.ts:50

    • Optional Readonly wrap

    wrap?: ITextWrapping
    +
  • Defined in src/file/drawing/floating/floating-position.ts:56

    • Optional Readonly zIndex

    zIndex?: number
    +
  • Defined in src/file/drawing/floating/floating-position.ts:57
    • diff --git a/api/interfaces/IFontAttributesProperties.html b/api/interfaces/IFontAttributesProperties.html index b385a42f8f..6e95844b91 100644 --- a/api/interfaces/IFontAttributesProperties.html +++ b/api/interfaces/IFontAttributesProperties.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IFontAttributesProperties
    +
  • IFontAttributesProperties
    • @@ -36,27 +38,27 @@

    Optional Readonly ascii

    ascii?: string
    +
  • Defined in src/file/paragraph/run/run-fonts.ts:4

    • Optional Readonly cs

    cs?: string
    +
  • Defined in src/file/paragraph/run/run-fonts.ts:5

    • Optional Readonly eastAsia

    eastAsia?: string
    +
  • Defined in src/file/paragraph/run/run-fonts.ts:6

    • Optional Readonly hAnsi

    hAnsi?: string
    +
  • Defined in src/file/paragraph/run/run-fonts.ts:7

    • Optional Readonly hint

    hint?: string
    +
  • Defined in src/file/paragraph/run/run-fonts.ts:8
    • diff --git a/api/interfaces/IHeaderFooterGroup.html b/api/interfaces/IHeaderFooterGroup.html index 1e054428e3..52d8848e78 100644 --- a/api/interfaces/IHeaderFooterGroup.html +++ b/api/interfaces/IHeaderFooterGroup.html @@ -21,7 +21,9 @@

    Hierarchy

      -
    • IHeaderFooterGroup
    +
  • IHeaderFooterGroup
    • @@ -39,17 +41,17 @@

    Optional Readonly default

    default?: T
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:22

    • Optional Readonly even

    even?: T
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:24

    • Optional Readonly first

    first?: T
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:23
    • diff --git a/api/interfaces/IHeaderFooterOptions.html b/api/interfaces/IHeaderFooterOptions.html index 246eec9e33..0d07d7aa3c 100644 --- a/api/interfaces/IHeaderFooterOptions.html +++ b/api/interfaces/IHeaderFooterOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IHeaderFooterOptions
    +
  • IHeaderFooterOptions
    • @@ -33,12 +35,12 @@

    Optional Readonly id

    id?: number
    +
  • Defined in src/file/document/body/section-properties/properties/header-footer-reference.ts:37

    • Optional Readonly type

    type?: HeaderFooterReferenceType
    +
  • Defined in src/file/document/body/section-properties/properties/header-footer-reference.ts:36
    • diff --git a/api/interfaces/IHeaderOptions.html b/api/interfaces/IHeaderOptions.html index 69b369b8eb..c1931fe5b6 100644 --- a/api/interfaces/IHeaderOptions.html +++ b/api/interfaces/IHeaderOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IHeaderOptions
    +
  • IHeaderOptions
    • @@ -32,7 +34,7 @@

    Readonly children

    children: (Paragraph | Table)[]
    +
  • Defined in src/file/header.ts:5
    • diff --git a/api/interfaces/IHorizontalPositionOptions.html b/api/interfaces/IHorizontalPositionOptions.html index ae2145e5c8..1d248ba937 100644 --- a/api/interfaces/IHorizontalPositionOptions.html +++ b/api/interfaces/IHorizontalPositionOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IHorizontalPositionOptions
    +
  • IHorizontalPositionOptions
    • @@ -34,17 +36,17 @@

    Optional Readonly align

    align?: HorizontalPositionAlign
    +
  • Defined in src/file/drawing/floating/floating-position.ts:31

    • Optional Readonly offset

    offset?: number
    +
  • Defined in src/file/drawing/floating/floating-position.ts:32

    • Optional Readonly relative

    relative?: HorizontalPositionRelativeFrom
    +
  • Defined in src/file/drawing/floating/floating-position.ts:30
    • diff --git a/api/interfaces/IImageOptions.html b/api/interfaces/IImageOptions.html index c147ad99f8..17233e2cb6 100644 --- a/api/interfaces/IImageOptions.html +++ b/api/interfaces/IImageOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IImageOptions
    +
  • IImageOptions
    • @@ -34,17 +36,17 @@

    Readonly data

    data: string | ArrayBuffer | Uint8Array | Buffer
    +
  • Defined in src/file/paragraph/run/image-run.ts:11

    • Optional Readonly floating

    floating?: IFloating
    +
  • Defined in src/file/paragraph/run/image-run.ts:13

    • Readonly transformation

    transformation: IMediaTransformation
    +
  • Defined in src/file/paragraph/run/image-run.ts:12
    • diff --git a/api/interfaces/IIndentAttributesProperties.html b/api/interfaces/IIndentAttributesProperties.html index 9a2d564e39..d967ee405d 100644 --- a/api/interfaces/IIndentAttributesProperties.html +++ b/api/interfaces/IIndentAttributesProperties.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IIndentAttributesProperties
    +
  • IIndentAttributesProperties
    • @@ -37,32 +39,32 @@

    Optional Readonly end

    end?: string | number
    +
  • Defined in src/file/paragraph/formatting/indent.ts:7

    • Optional Readonly firstLine

    firstLine?: string | number
    +
  • Defined in src/file/paragraph/formatting/indent.ts:11

    • Optional Readonly hanging

    hanging?: string | number
    +
  • Defined in src/file/paragraph/formatting/indent.ts:10

    • Optional Readonly left

    left?: string | number
    +
  • Defined in src/file/paragraph/formatting/indent.ts:8

    • Optional Readonly right

    right?: string | number
    +
  • Defined in src/file/paragraph/formatting/indent.ts:9

    • Optional Readonly start

    start?: string | number
    +
  • Defined in src/file/paragraph/formatting/indent.ts:6
    • diff --git a/api/interfaces/ILevelParagraphStylePropertiesOptions.html b/api/interfaces/ILevelParagraphStylePropertiesOptions.html index 6da33ff6df..6ac40b9384 100644 --- a/api/interfaces/ILevelParagraphStylePropertiesOptions.html +++ b/api/interfaces/ILevelParagraphStylePropertiesOptions.html @@ -18,7 +18,9 @@ +
  • IParagraphStylePropertiesOptions
    • @@ -43,52 +45,52 @@

    Optional Readonly alignment

    alignment?: AlignmentType
    +
  • Defined in src/file/paragraph/properties.ts:18

    • Optional Readonly contextualSpacing

    contextualSpacing?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:20

    • Optional Readonly indent

    indent?: IIndentAttributesProperties
    +
  • Defined in src/file/paragraph/properties.ts:23

    • Optional Readonly keepLines

    keepLines?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:26

    • Optional Readonly keepNext

    keepNext?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:25

    • Optional Readonly leftTabStop

    leftTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:22

    • Optional Readonly outlineLevel

    outlineLevel?: number
    +
  • Defined in src/file/paragraph/properties.ts:27

    • Optional Readonly rightTabStop

    rightTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:21

    • Optional Readonly spacing

    spacing?: ISpacingProperties
    +
  • Defined in src/file/paragraph/properties.ts:24

    • Optional Readonly thematicBreak

    thematicBreak?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:19
    • diff --git a/api/interfaces/ILevelsOptions.html b/api/interfaces/ILevelsOptions.html index 4badf4325c..74d5c2d173 100644 --- a/api/interfaces/ILevelsOptions.html +++ b/api/interfaces/ILevelsOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ILevelsOptions
    +
  • ILevelsOptions
    • @@ -38,22 +40,22 @@

    Optional Readonly alignment

    alignment?: AlignmentType
    +
  • Defined in src/file/numbering/level.ts:87

    • Optional Readonly format

    format?: LevelFormat
    +
  • Defined in src/file/numbering/level.ts:85

    • Readonly level

    level: number
    +
  • Defined in src/file/numbering/level.ts:84

    • Optional Readonly start

    start?: number
    +
  • Defined in src/file/numbering/level.ts:88

    • Optional Readonly style

    style?: { paragraph?: ILevelParagraphStylePropertiesOptions; run?: IRunStylePropertiesOptions }
    @@ -65,17 +67,17 @@
  • Optional Readonly run?: IRunStylePropertiesOptions
    • +
  • Defined in src/file/numbering/level.ts:90

    • Optional Readonly suffix

    suffix?: LevelSuffix
    +
  • Defined in src/file/numbering/level.ts:89

    • Optional Readonly text

    text?: string
    +
  • Defined in src/file/numbering/level.ts:86
    • diff --git a/api/interfaces/ILineNumberAttributes.html b/api/interfaces/ILineNumberAttributes.html index c5bb2d1b56..0c35a9af6b 100644 --- a/api/interfaces/ILineNumberAttributes.html +++ b/api/interfaces/ILineNumberAttributes.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ILineNumberAttributes
    +
  • ILineNumberAttributes
    • @@ -35,22 +37,22 @@

    Optional Readonly countBy

    countBy?: number
    +
  • Defined in src/file/document/body/section-properties/properties/line-number.ts:26

    • Optional Readonly distance

    distance?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/line-number.ts:29

    • Optional Readonly restart

    restart?: LineNumberRestartFormat
    +
  • Defined in src/file/document/body/section-properties/properties/line-number.ts:28

    • Optional Readonly start

    start?: number
    +
  • Defined in src/file/document/body/section-properties/properties/line-number.ts:27
    • diff --git a/api/interfaces/IMargins.html b/api/interfaces/IMargins.html index 3688457eaa..78b573ff5a 100644 --- a/api/interfaces/IMargins.html +++ b/api/interfaces/IMargins.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMargins
    +
  • IMargins
    • @@ -35,22 +37,22 @@

    Optional Readonly bottom

    bottom?: number
    +
  • Defined in src/file/drawing/floating/floating-position.ts:43

    • Optional Readonly left

    left?: number
    +
  • Defined in src/file/drawing/floating/floating-position.ts:42

    • Optional Readonly right

    right?: number
    +
  • Defined in src/file/drawing/floating/floating-position.ts:45

    • Optional Readonly top

    top?: number
    +
  • Defined in src/file/drawing/floating/floating-position.ts:44
    • diff --git a/api/interfaces/IMathFractionOptions.html b/api/interfaces/IMathFractionOptions.html index 46d077c81b..7ea2f9d9f1 100644 --- a/api/interfaces/IMathFractionOptions.html +++ b/api/interfaces/IMathFractionOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMathFractionOptions
    +
  • IMathFractionOptions
    • @@ -33,12 +35,12 @@

    Readonly denominator

    denominator: MathComponent[]
    +
  • Defined in src/file/paragraph/math/fraction/math-fraction.ts:9

    • Readonly numerator

    numerator: MathComponent[]
    +
  • Defined in src/file/paragraph/math/fraction/math-fraction.ts:8
    • diff --git a/api/interfaces/IMathFunctionOptions.html b/api/interfaces/IMathFunctionOptions.html index e319e6e900..0c7ed0a8e2 100644 --- a/api/interfaces/IMathFunctionOptions.html +++ b/api/interfaces/IMathFunctionOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMathFunctionOptions
    +
  • IMathFunctionOptions
    • @@ -33,12 +35,12 @@

    Readonly children

    children: MathComponent[]
    +
  • Defined in src/file/paragraph/math/function/math-function.ts:10

    • Readonly name

    name: MathComponent[]
    +
  • Defined in src/file/paragraph/math/function/math-function.ts:11
    • diff --git a/api/interfaces/IMathOptions.html b/api/interfaces/IMathOptions.html index 2183338f1e..67cf11d618 100644 --- a/api/interfaces/IMathOptions.html +++ b/api/interfaces/IMathOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMathOptions
    +
  • IMathOptions
    • @@ -32,7 +34,7 @@

    Readonly children

    children: MathComponent[]
    +
  • Defined in src/file/paragraph/math/math.ts:7
    • diff --git a/api/interfaces/IMathPreSubSuperScriptOptions.html b/api/interfaces/IMathPreSubSuperScriptOptions.html index 5e34077c0b..7ebb1e1453 100644 --- a/api/interfaces/IMathPreSubSuperScriptOptions.html +++ b/api/interfaces/IMathPreSubSuperScriptOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMathPreSubSuperScriptOptions
    +
  • IMathPreSubSuperScriptOptions
    • @@ -34,17 +36,17 @@

    Readonly children

    children: MathComponent[]
    +
  • Defined in src/file/paragraph/math/script/pre-sub-super-script/math-pre-sub-super-script-function.ts:9

    • Readonly subScript

    subScript: MathComponent[]
    +
  • Defined in src/file/paragraph/math/script/pre-sub-super-script/math-pre-sub-super-script-function.ts:10

    • Readonly superScript

    superScript: MathComponent[]
    +
  • Defined in src/file/paragraph/math/script/pre-sub-super-script/math-pre-sub-super-script-function.ts:11
    • diff --git a/api/interfaces/IMathRadicalOptions.html b/api/interfaces/IMathRadicalOptions.html index 28069bf6e4..92f44bdca6 100644 --- a/api/interfaces/IMathRadicalOptions.html +++ b/api/interfaces/IMathRadicalOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMathRadicalOptions
    +
  • IMathRadicalOptions
    • @@ -33,12 +35,12 @@

    Readonly children

    children: MathComponent[]
    +
  • Defined in src/file/paragraph/math/radical/math-radical.ts:10

    • Optional Readonly degree

    degree?: MathComponent[]
    +
  • Defined in src/file/paragraph/math/radical/math-radical.ts:11
    • diff --git a/api/interfaces/IMathSubScriptOptions.html b/api/interfaces/IMathSubScriptOptions.html index cd9eb92f20..9e564448bc 100644 --- a/api/interfaces/IMathSubScriptOptions.html +++ b/api/interfaces/IMathSubScriptOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMathSubScriptOptions
    +
  • IMathSubScriptOptions
    • @@ -33,12 +35,12 @@

    Readonly children

    children: MathComponent[]
    +
  • Defined in src/file/paragraph/math/script/sub-script/math-sub-script-function.ts:9

    • Readonly subScript

    subScript: MathComponent[]
    +
  • Defined in src/file/paragraph/math/script/sub-script/math-sub-script-function.ts:10
    • diff --git a/api/interfaces/IMathSubSuperScriptOptions.html b/api/interfaces/IMathSubSuperScriptOptions.html index daa27a6913..d8a0521c2b 100644 --- a/api/interfaces/IMathSubSuperScriptOptions.html +++ b/api/interfaces/IMathSubSuperScriptOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMathSubSuperScriptOptions
    +
  • IMathSubSuperScriptOptions
    • @@ -34,17 +36,17 @@

    Readonly children

    children: MathComponent[]
    +
  • Defined in src/file/paragraph/math/script/sub-super-script/math-sub-super-script-function.ts:9

    • Readonly subScript

    subScript: MathComponent[]
    +
  • Defined in src/file/paragraph/math/script/sub-super-script/math-sub-super-script-function.ts:10

    • Readonly superScript

    superScript: MathComponent[]
    +
  • Defined in src/file/paragraph/math/script/sub-super-script/math-sub-super-script-function.ts:11
    • diff --git a/api/interfaces/IMathSumOptions.html b/api/interfaces/IMathSumOptions.html index 004061dd46..5f36bf1692 100644 --- a/api/interfaces/IMathSumOptions.html +++ b/api/interfaces/IMathSumOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMathSumOptions
    +
  • IMathSumOptions
    • @@ -34,17 +36,17 @@

    Readonly children

    children: MathComponent[]
    +
  • Defined in src/file/paragraph/math/n-ary/math-sum.ts:11

    • Optional Readonly subScript

    subScript?: MathComponent[]
    +
  • Defined in src/file/paragraph/math/n-ary/math-sum.ts:12

    • Optional Readonly superScript

    superScript?: MathComponent[]
    +
  • Defined in src/file/paragraph/math/n-ary/math-sum.ts:13
    • diff --git a/api/interfaces/IMathSuperScriptOptions.html b/api/interfaces/IMathSuperScriptOptions.html index b0626e87ab..0887a682ed 100644 --- a/api/interfaces/IMathSuperScriptOptions.html +++ b/api/interfaces/IMathSuperScriptOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMathSuperScriptOptions
    +
  • IMathSuperScriptOptions
    • @@ -33,12 +35,12 @@

    Readonly children

    children: MathComponent[]
    +
  • Defined in src/file/paragraph/math/script/super-script/math-super-script-function.ts:9

    • Readonly superScript

    superScript: MathComponent[]
    +
  • Defined in src/file/paragraph/math/script/super-script/math-super-script-function.ts:10
    • diff --git a/api/interfaces/IMediaData.html b/api/interfaces/IMediaData.html index 18d3436bdb..4122a79110 100644 --- a/api/interfaces/IMediaData.html +++ b/api/interfaces/IMediaData.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMediaData
    +
  • IMediaData
    • @@ -34,17 +36,17 @@

    Readonly fileName

    fileName: string
    +
  • Defined in src/file/media/data.ts:19

    • Readonly stream

    stream: ArrayBuffer | Uint8Array | Buffer
    +
  • Defined in src/file/media/data.ts:18

    • Readonly transformation

    transformation: IMediaDataTransformation
    +
  • Defined in src/file/media/data.ts:20
    • diff --git a/api/interfaces/IMediaDataTransformation.html b/api/interfaces/IMediaDataTransformation.html index 2c1ae39315..b9e18bd9e8 100644 --- a/api/interfaces/IMediaDataTransformation.html +++ b/api/interfaces/IMediaDataTransformation.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMediaDataTransformation
    +
  • IMediaDataTransformation
    • @@ -42,7 +44,7 @@
  • Readonly y: number
    • +
  • Defined in src/file/media/data.ts:6

    • Optional Readonly flip

    flip?: { horizontal?: boolean; vertical?: boolean }
    @@ -54,7 +56,7 @@
  • Optional Readonly vertical?: boolean
    • +
  • Defined in src/file/media/data.ts:10

    • Readonly pixels

    pixels: { x: number; y: number }
    @@ -66,12 +68,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
    • diff --git a/api/interfaces/IMediaTransformation.html b/api/interfaces/IMediaTransformation.html index d105d23467..86c0b16b5e 100644 --- a/api/interfaces/IMediaTransformation.html +++ b/api/interfaces/IMediaTransformation.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IMediaTransformation
    +
  • IMediaTransformation
    • @@ -42,22 +44,22 @@
  • Optional Readonly vertical?: boolean
    • +
  • Defined in src/file/media/media.ts:8

    • Readonly height

    height: number
    +
  • Defined in src/file/media/media.ts:7

    • Optional Readonly rotation

    rotation?: number
    +
  • Defined in src/file/media/media.ts:12

    • Readonly width

    width: number
    +
  • Defined in src/file/media/media.ts:6
    • diff --git a/api/interfaces/INumberingOptions.html b/api/interfaces/INumberingOptions.html index eee48232c9..8606f46354 100644 --- a/api/interfaces/INumberingOptions.html +++ b/api/interfaces/INumberingOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • INumberingOptions
    +
  • INumberingOptions
    • @@ -32,7 +34,7 @@

    Readonly config

    config: { levels: ILevelsOptions[]; reference: string }[]
    +
  • Defined in src/file/numbering/numbering.ts:13
    • diff --git a/api/interfaces/IPageBorderAttributes.html b/api/interfaces/IPageBorderAttributes.html index a20b6f8693..b96ba6f09a 100644 --- a/api/interfaces/IPageBorderAttributes.html +++ b/api/interfaces/IPageBorderAttributes.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IPageBorderAttributes
    +
  • IPageBorderAttributes
    • @@ -34,17 +36,17 @@

    Optional Readonly display

    display?: PageBorderDisplay
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:41

    • Optional Readonly offsetFrom

    offsetFrom?: PageBorderOffsetFrom
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:42

    • Optional Readonly zOrder

    zOrder?: PageBorderZOrder
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:43
    • diff --git a/api/interfaces/IPageBordersOptions.html b/api/interfaces/IPageBordersOptions.html index 3e2a4cca04..abad9319c1 100644 --- a/api/interfaces/IPageBordersOptions.html +++ b/api/interfaces/IPageBordersOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IPageBordersOptions
    +
  • IPageBordersOptions
    • @@ -36,27 +38,27 @@

    Optional Readonly pageBorderBottom

    pageBorderBottom?: IBorderOptions
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:50

    • Optional Readonly pageBorderLeft

    pageBorderLeft?: IBorderOptions
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:51

    • Optional Readonly pageBorderRight

    pageBorderRight?: IBorderOptions
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:49

    • Optional Readonly pageBorderTop

    pageBorderTop?: IBorderOptions
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:48

    • Optional Readonly pageBorders

    pageBorders?: IPageBorderAttributes
    +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:47
    • diff --git a/api/interfaces/IPageMarginAttributes.html b/api/interfaces/IPageMarginAttributes.html index 904a892c73..317570fab9 100644 --- a/api/interfaces/IPageMarginAttributes.html +++ b/api/interfaces/IPageMarginAttributes.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IPageMarginAttributes
    +
  • IPageMarginAttributes
    • @@ -38,37 +40,37 @@

    Optional Readonly bottom

    bottom?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:16

    • Optional Readonly footer

    footer?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:19

    • Optional Readonly gutter

    gutter?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:20

    • Optional Readonly header

    header?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:18

    • Optional Readonly left

    left?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:17

    • Optional Readonly right

    right?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:15

    • Optional Readonly top

    top?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:14
    • diff --git a/api/interfaces/IPageNumberTypeAttributes.html b/api/interfaces/IPageNumberTypeAttributes.html index 4c19058e1f..4c6062e71e 100644 --- a/api/interfaces/IPageNumberTypeAttributes.html +++ b/api/interfaces/IPageNumberTypeAttributes.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IPageNumberTypeAttributes
    +
  • IPageNumberTypeAttributes
    • @@ -34,17 +36,17 @@

    Optional Readonly formatType

    formatType?: NumberFormat
    +
  • Defined in src/file/document/body/section-properties/properties/page-number.ts:25

    • Optional Readonly separator

    separator?: PageNumberSeparator
    +
  • Defined in src/file/document/body/section-properties/properties/page-number.ts:26

    • Optional Readonly start

    start?: number
    +
  • Defined in src/file/document/body/section-properties/properties/page-number.ts:24
    • diff --git a/api/interfaces/IPageSizeAttributes.html b/api/interfaces/IPageSizeAttributes.html index 6e0b27b5a3..5b1162c8a0 100644 --- a/api/interfaces/IPageSizeAttributes.html +++ b/api/interfaces/IPageSizeAttributes.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IPageSizeAttributes
    +
  • IPageSizeAttributes
    • @@ -34,17 +36,17 @@

    Optional Readonly height

    height?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-size.ts:23

    • Optional Readonly orientation

    orientation?: PageOrientation
    +
  • Defined in src/file/document/body/section-properties/properties/page-size.ts:24

    • Optional Readonly width

    width?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-size.ts:22
    • diff --git a/api/interfaces/IParagraphOptions.html b/api/interfaces/IParagraphOptions.html index 26f1dd1b80..79ad46886c 100644 --- a/api/interfaces/IParagraphOptions.html +++ b/api/interfaces/IParagraphOptions.html @@ -18,7 +18,9 @@ +
  • IParagraphOptions
    • @@ -58,19 +60,19 @@
    alignment?: AlignmentType
    +
  • Defined in src/file/paragraph/properties.ts:18

    • Optional Readonly bidirectional

    bidirectional?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:42

    • Optional Readonly border

    border?: IBordersOptions
    +
  • Defined in src/file/paragraph/properties.ts:40

    • Optional Readonly bullet

    bullet?: { level: number }
    @@ -81,54 +83,54 @@
    Readonly level: number
    +
  • Defined in src/file/paragraph/properties.ts:50

    • Optional Readonly children

    children?: ParagraphChild[]
    +
  • Defined in src/file/paragraph/paragraph.ts:39

    • Optional Readonly contextualSpacing

    contextualSpacing?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:20

    • Optional Readonly frame

    frame?: IFrameOptions
    +
  • Defined in src/file/paragraph/properties.ts:55

    • Optional Readonly heading

    heading?: HeadingLevel
    +
  • Defined in src/file/paragraph/properties.ts:41

    • Optional Readonly indent

    indent?: IIndentAttributesProperties
    +
  • Defined in src/file/paragraph/properties.ts:23

    • Optional Readonly keepLines

    keepLines?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:26

    • Optional Readonly keepNext

    keepNext?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:25

    • Optional Readonly leftTabStop

    leftTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:22

    • Optional Readonly numbering

    numbering?: { custom?: boolean; instance?: number; level: number; reference: string }
    @@ -145,72 +147,72 @@
    Readonly reference: string
    +
  • Defined in src/file/paragraph/properties.ts:31

    • Optional Readonly outlineLevel

    outlineLevel?: number
    +
  • Defined in src/file/paragraph/properties.ts:27

    • Optional Readonly pageBreakBefore

    pageBreakBefore?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:43

    • Optional Readonly rightTabStop

    rightTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:21

    • Optional Readonly shading

    shading?: IShadingAttributesProperties
    +
  • Defined in src/file/paragraph/properties.ts:53

    • Optional Readonly spacing

    spacing?: ISpacingProperties
    +
  • Defined in src/file/paragraph/properties.ts:24

    • Optional Readonly style

    style?: string
    +
  • Defined in src/file/paragraph/properties.ts:49

    • Optional Readonly suppressLineNumbers

    suppressLineNumbers?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:56

    • Optional Readonly tabStops

    tabStops?: { leader?: LeaderType; position: number; type: TabStopType }[]
    +
  • Defined in src/file/paragraph/properties.ts:44

    • Optional Readonly text

    text?: string
    +
  • Defined in src/file/paragraph/paragraph.ts:38

    • Optional Readonly thematicBreak

    thematicBreak?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:19

    • Optional Readonly widowControl

    widowControl?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:54
    • diff --git a/api/interfaces/IParagraphPropertiesOptions.html b/api/interfaces/IParagraphPropertiesOptions.html index 13f33c466a..741e30a6fd 100644 --- a/api/interfaces/IParagraphPropertiesOptions.html +++ b/api/interfaces/IParagraphPropertiesOptions.html @@ -20,7 +20,9 @@ +
  • IParagraphOptions
    • @@ -58,17 +60,17 @@
    alignment?: AlignmentType
    +
  • Defined in src/file/paragraph/properties.ts:18

    • Optional Readonly bidirectional

    bidirectional?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:42

    • Optional Readonly border

    border?: IBordersOptions
    +
  • Defined in src/file/paragraph/properties.ts:40

    • Optional Readonly bullet

    bullet?: { level: number }
    @@ -78,47 +80,47 @@
  • Readonly level: number
    • +
  • Defined in src/file/paragraph/properties.ts:50

    • Optional Readonly contextualSpacing

    contextualSpacing?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:20

    • Optional Readonly frame

    frame?: IFrameOptions
    +
  • Defined in src/file/paragraph/properties.ts:55

    • Optional Readonly heading

    heading?: HeadingLevel
    +
  • Defined in src/file/paragraph/properties.ts:41

    • Optional Readonly indent

    indent?: IIndentAttributesProperties
    +
  • Defined in src/file/paragraph/properties.ts:23

    • Optional Readonly keepLines

    keepLines?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:26

    • Optional Readonly keepNext

    keepNext?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:25

    • Optional Readonly leftTabStop

    leftTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:22

    • Optional Readonly numbering

    numbering?: { custom?: boolean; instance?: number; level: number; reference: string }
    @@ -135,61 +137,61 @@
    Readonly reference: string
    +
  • Defined in src/file/paragraph/properties.ts:31

    • Optional Readonly outlineLevel

    outlineLevel?: number
    +
  • Defined in src/file/paragraph/properties.ts:27

    • Optional Readonly pageBreakBefore

    pageBreakBefore?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:43

    • Optional Readonly rightTabStop

    rightTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:21

    • Optional Readonly shading

    shading?: IShadingAttributesProperties
    +
  • Defined in src/file/paragraph/properties.ts:53

    • Optional Readonly spacing

    spacing?: ISpacingProperties
    +
  • Defined in src/file/paragraph/properties.ts:24

    • Optional Readonly style

    style?: string
    +
  • Defined in src/file/paragraph/properties.ts:49

    • Optional Readonly suppressLineNumbers

    suppressLineNumbers?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:56

    • Optional Readonly tabStops

    tabStops?: { leader?: LeaderType; position: number; type: TabStopType }[]
    +
  • Defined in src/file/paragraph/properties.ts:44

    • Optional Readonly thematicBreak

    thematicBreak?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:19

    • Optional Readonly widowControl

    widowControl?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:54
    • diff --git a/api/interfaces/IParagraphStyleOptions.html b/api/interfaces/IParagraphStyleOptions.html index 6443178906..6f8191fb92 100644 --- a/api/interfaces/IParagraphStyleOptions.html +++ b/api/interfaces/IParagraphStyleOptions.html @@ -18,7 +18,9 @@ +
  • IParagraphStyleOptions
    • @@ -45,66 +47,66 @@
    basedOn?: string
    +
  • Defined in src/file/styles/style/style.ts:44

    • Readonly id

    id: string
    +
  • Defined in src/file/styles/style/paragraph-style.ts:11

    • Optional Readonly link

    link?: string
    +
  • Defined in src/file/styles/style/style.ts:46

    • Optional Readonly name

    name?: string
    +
  • Defined in src/file/styles/style/paragraph-style.ts:12

    • Optional Readonly next

    next?: string
    +
  • Defined in src/file/styles/style/style.ts:45

    • Optional Readonly paragraph

    paragraph?: IParagraphStylePropertiesOptions
    +
  • Defined in src/file/styles/style/paragraph-style.ts:6

    • Optional Readonly quickFormat

    quickFormat?: boolean
    +
  • Defined in src/file/styles/style/style.ts:50

    • Optional Readonly run

    run?: IRunStylePropertiesOptions
    +
  • Defined in src/file/styles/style/paragraph-style.ts:7

    • Optional Readonly semiHidden

    semiHidden?: boolean
    +
  • Defined in src/file/styles/style/style.ts:48

    • Optional Readonly uiPriority

    uiPriority?: number
    +
  • Defined in src/file/styles/style/style.ts:47

    • Optional Readonly unhideWhenUsed

    unhideWhenUsed?: boolean
    +
  • Defined in src/file/styles/style/style.ts:49
    • diff --git a/api/interfaces/IParagraphStylePropertiesOptions.html b/api/interfaces/IParagraphStylePropertiesOptions.html index 52e8b382cd..457fa8524f 100644 --- a/api/interfaces/IParagraphStylePropertiesOptions.html +++ b/api/interfaces/IParagraphStylePropertiesOptions.html @@ -20,7 +20,9 @@ +
  • IParagraphPropertiesOptions
    • @@ -47,37 +49,37 @@
    alignment?: AlignmentType
    +
  • Defined in src/file/paragraph/properties.ts:18

    • Optional Readonly contextualSpacing

    contextualSpacing?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:20

    • Optional Readonly indent

    indent?: IIndentAttributesProperties
    +
  • Defined in src/file/paragraph/properties.ts:23

    • Optional Readonly keepLines

    keepLines?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:26

    • Optional Readonly keepNext

    keepNext?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:25

    • Optional Readonly leftTabStop

    leftTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:22

    • Optional Readonly numbering

    numbering?: { custom?: boolean; instance?: number; level: number; reference: string }
    @@ -93,31 +95,31 @@
  • Readonly reference: string
    • +
  • Defined in src/file/paragraph/properties.ts:31

    • Optional Readonly outlineLevel

    outlineLevel?: number
    +
  • Defined in src/file/paragraph/properties.ts:27

    • Optional Readonly rightTabStop

    rightTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:21

    • Optional Readonly spacing

    spacing?: ISpacingProperties
    +
  • Defined in src/file/paragraph/properties.ts:24

    • Optional Readonly thematicBreak

    thematicBreak?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:19
    • diff --git a/api/interfaces/IRunOptions.html b/api/interfaces/IRunOptions.html index 3ff1ca00ec..cddcc220b4 100644 --- a/api/interfaces/IRunOptions.html +++ b/api/interfaces/IRunOptions.html @@ -20,7 +20,9 @@ +
  • ISymbolRunOptions
    • @@ -66,59 +68,59 @@
    allCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:35

    • Optional Readonly bold

    bold?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:19

    • Optional Readonly boldComplexScript

    boldComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:20

    • Optional Readonly border

    border?: IBorderOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:48

    • Optional Readonly break

    break?: number
    +
  • Defined in src/file/paragraph/run/run.ts:16

    • Optional Readonly characterSpacing

    characterSpacing?: number
    +
  • Defined in src/file/paragraph/run/properties.ts:43

    • Optional Readonly children

    children?: (string | FootnoteReferenceRun | FieldInstruction | Begin | Separate | End)[]
    +
  • Defined in src/file/paragraph/run/run.ts:15

    • Optional Readonly color

    color?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:30

    • Optional Readonly doubleStrike

    doubleStrike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:37

    • Optional Readonly emboss

    emboss?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:45

    • Optional Readonly emphasisMark

    emphasisMark?: { type?: DOT }
    @@ -129,114 +131,114 @@
    Optional Readonly type?: DOT
    +
  • Defined in src/file/paragraph/run/properties.ts:27

    • Optional Readonly font

    font?: string | IFontAttributesProperties | IFontOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:40

    • Optional Readonly highlight

    highlight?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:41

    • Optional Readonly highlightComplexScript

    highlightComplexScript?: string | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:42

    • Optional Readonly imprint

    imprint?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:46

    • Optional Readonly italics

    italics?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:21

    • Optional Readonly italicsComplexScript

    italicsComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:22

    • Optional Readonly revision

    revision?: IRunPropertiesChangeOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:47

    • Optional Readonly rightToLeft

    rightToLeft?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:33

    • Optional Readonly shading

    shading?: IShadingAttributesProperties
    +
  • Defined in src/file/paragraph/run/properties.ts:44

    • Optional Readonly size

    size?: string | number
    +
  • Defined in src/file/paragraph/run/properties.ts:31

    • Optional Readonly sizeComplexScript

    sizeComplexScript?: string | number | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:32

    • Optional Readonly smallCaps

    smallCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:34

    • Optional Readonly space

    space?: SpaceType
    +
  • Defined in src/file/paragraph/run/properties.ts:49

    • Optional Readonly strike

    strike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:36

    • Optional Readonly style

    style?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:53

    • Optional Readonly subScript

    subScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:38

    • Optional Readonly superScript

    superScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:39

    • Optional Readonly text

    text?: string
    +
  • Defined in src/file/paragraph/run/run.ts:17

    • Optional Readonly underline

    underline?: { color?: string; type?: UnderlineType }
    @@ -249,7 +251,7 @@
    Optional Readonly type?: UnderlineType
    +
  • Defined in src/file/paragraph/run/properties.ts:23
    • diff --git a/api/interfaces/IRunPropertiesChangeOptions.html b/api/interfaces/IRunPropertiesChangeOptions.html index 42946e945f..1588b774c0 100644 --- a/api/interfaces/IRunPropertiesChangeOptions.html +++ b/api/interfaces/IRunPropertiesChangeOptions.html @@ -19,7 +19,9 @@
  • IRunPropertiesOptions
  • IChangedAttributesProperties
      -
    • IRunPropertiesChangeOptions
    • +
  • IRunPropertiesChangeOptions
    • @@ -65,61 +67,61 @@
    allCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:35

    • Readonly author

    author: string
    +
  • Defined in src/file/track-revision/track-revision.ts:5

    • Optional Readonly bold

    bold?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:19

    • Optional Readonly boldComplexScript

    boldComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:20

    • Optional Readonly border

    border?: IBorderOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:48

    • Optional Readonly characterSpacing

    characterSpacing?: number
    +
  • Defined in src/file/paragraph/run/properties.ts:43

    • Optional Readonly color

    color?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:30

    • Readonly date

    date: string
    +
  • Defined in src/file/track-revision/track-revision.ts:6

    • Optional Readonly doubleStrike

    doubleStrike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:37

    • Optional Readonly emboss

    emboss?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:45

    • Optional Readonly emphasisMark

    emphasisMark?: { type?: DOT }
    @@ -130,115 +132,115 @@
    Optional Readonly type?: DOT
    +
  • Defined in src/file/paragraph/run/properties.ts:27

    • Optional Readonly font

    font?: string | IFontAttributesProperties | IFontOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:40

    • Optional Readonly highlight

    highlight?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:41

    • Optional Readonly highlightComplexScript

    highlightComplexScript?: string | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:42

    • Readonly id

    id: number
    +
  • Defined in src/file/track-revision/track-revision.ts:4

    • Optional Readonly imprint

    imprint?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:46

    • Optional Readonly italics

    italics?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:21

    • Optional Readonly italicsComplexScript

    italicsComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:22

    • Optional Readonly revision

    revision?: IRunPropertiesChangeOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:47

    • Optional Readonly rightToLeft

    rightToLeft?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:33

    • Optional Readonly shading

    shading?: IShadingAttributesProperties
    +
  • Defined in src/file/paragraph/run/properties.ts:44

    • Optional Readonly size

    size?: string | number
    +
  • Defined in src/file/paragraph/run/properties.ts:31

    • Optional Readonly sizeComplexScript

    sizeComplexScript?: string | number | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:32

    • Optional Readonly smallCaps

    smallCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:34

    • Optional Readonly space

    space?: SpaceType
    +
  • Defined in src/file/paragraph/run/properties.ts:49

    • Optional Readonly strike

    strike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:36

    • Optional Readonly style

    style?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:53

    • Optional Readonly subScript

    subScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:38

    • Optional Readonly superScript

    superScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:39

    • Optional Readonly underline

    underline?: { color?: string; type?: UnderlineType }
    @@ -251,7 +253,7 @@
    Optional Readonly type?: UnderlineType
    +
  • Defined in src/file/paragraph/run/properties.ts:23
    • diff --git a/api/interfaces/IRunPropertiesOptions.html b/api/interfaces/IRunPropertiesOptions.html index dd77cc2efd..a1ce9d2e43 100644 --- a/api/interfaces/IRunPropertiesOptions.html +++ b/api/interfaces/IRunPropertiesOptions.html @@ -21,7 +21,9 @@
  • IRunPropertiesOptions
    • +
  • IRunPropertiesChangeOptions
    • @@ -64,49 +66,49 @@
    allCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:35

    • Optional Readonly bold

    bold?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:19

    • Optional Readonly boldComplexScript

    boldComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:20

    • Optional Readonly border

    border?: IBorderOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:48

    • Optional Readonly characterSpacing

    characterSpacing?: number
    +
  • Defined in src/file/paragraph/run/properties.ts:43

    • Optional Readonly color

    color?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:30

    • Optional Readonly doubleStrike

    doubleStrike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:37

    • Optional Readonly emboss

    emboss?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:45

    • Optional Readonly emphasisMark

    emphasisMark?: { type?: DOT }
    @@ -117,108 +119,108 @@
    Optional Readonly type?: DOT
    +
  • Defined in src/file/paragraph/run/properties.ts:27

    • Optional Readonly font

    font?: string | IFontAttributesProperties | IFontOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:40

    • Optional Readonly highlight

    highlight?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:41

    • Optional Readonly highlightComplexScript

    highlightComplexScript?: string | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:42

    • Optional Readonly imprint

    imprint?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:46

    • Optional Readonly italics

    italics?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:21

    • Optional Readonly italicsComplexScript

    italicsComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:22

    • Optional Readonly revision

    revision?: IRunPropertiesChangeOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:47

    • Optional Readonly rightToLeft

    rightToLeft?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:33

    • Optional Readonly shading

    shading?: IShadingAttributesProperties
    +
  • Defined in src/file/paragraph/run/properties.ts:44

    • Optional Readonly size

    size?: string | number
    +
  • Defined in src/file/paragraph/run/properties.ts:31

    • Optional Readonly sizeComplexScript

    sizeComplexScript?: string | number | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:32

    • Optional Readonly smallCaps

    smallCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:34

    • Optional Readonly space

    space?: SpaceType
    +
  • Defined in src/file/paragraph/run/properties.ts:49

    • Optional Readonly strike

    strike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:36

    • Optional Readonly style

    style?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:53

    • Optional Readonly subScript

    subScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:38

    • Optional Readonly superScript

    superScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:39

    • Optional Readonly underline

    underline?: { color?: string; type?: UnderlineType }
    @@ -231,7 +233,7 @@
    Optional Readonly type?: UnderlineType
    +
  • Defined in src/file/paragraph/run/properties.ts:23
    • diff --git a/api/interfaces/IRunStylePropertiesOptions.html b/api/interfaces/IRunStylePropertiesOptions.html index fe8162231b..d826f82d4d 100644 --- a/api/interfaces/IRunStylePropertiesOptions.html +++ b/api/interfaces/IRunStylePropertiesOptions.html @@ -18,7 +18,9 @@ +
  • IRunPropertiesOptions
    • @@ -59,42 +61,42 @@

    Optional Readonly allCaps

    allCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:35

    • Optional Readonly bold

    bold?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:19

    • Optional Readonly boldComplexScript

    boldComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:20

    • Optional Readonly border

    border?: IBorderOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:48

    • Optional Readonly characterSpacing

    characterSpacing?: number
    +
  • Defined in src/file/paragraph/run/properties.ts:43

    • Optional Readonly color

    color?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:30

    • Optional Readonly doubleStrike

    doubleStrike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:37

    • Optional Readonly emboss

    emboss?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:45

    • Optional Readonly emphasisMark

    emphasisMark?: { type?: DOT }
    @@ -104,87 +106,87 @@
  • Optional Readonly type?: DOT
    • +
  • Defined in src/file/paragraph/run/properties.ts:27

    • Optional Readonly font

    font?: string | IFontAttributesProperties | IFontOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:40

    • Optional Readonly highlight

    highlight?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:41

    • Optional Readonly highlightComplexScript

    highlightComplexScript?: string | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:42

    • Optional Readonly imprint

    imprint?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:46

    • Optional Readonly italics

    italics?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:21

    • Optional Readonly italicsComplexScript

    italicsComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:22

    • Optional Readonly revision

    revision?: IRunPropertiesChangeOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:47

    • Optional Readonly rightToLeft

    rightToLeft?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:33

    • Optional Readonly shading

    shading?: IShadingAttributesProperties
    +
  • Defined in src/file/paragraph/run/properties.ts:44

    • Optional Readonly size

    size?: string | number
    +
  • Defined in src/file/paragraph/run/properties.ts:31

    • Optional Readonly sizeComplexScript

    sizeComplexScript?: string | number | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:32

    • Optional Readonly smallCaps

    smallCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:34

    • Optional Readonly space

    space?: SpaceType
    +
  • Defined in src/file/paragraph/run/properties.ts:49

    • Optional Readonly strike

    strike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:36

    • Optional Readonly subScript

    subScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:38

    • Optional Readonly superScript

    superScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:39

    • Optional Readonly underline

    underline?: { color?: string; type?: UnderlineType }
    @@ -196,7 +198,7 @@
  • Optional Readonly type?: UnderlineType
    • +
  • Defined in src/file/paragraph/run/properties.ts:23
    • diff --git a/api/interfaces/ISectionOptions.html b/api/interfaces/ISectionOptions.html index c47941c7ed..6859772a2a 100644 --- a/api/interfaces/ISectionOptions.html +++ b/api/interfaces/ISectionOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ISectionOptions
    +
  • ISectionOptions
    • @@ -35,7 +37,7 @@

    Readonly children

    children: (Paragraph | Table | TableOfContents)[]
    +
  • Defined in src/file/file.ts:36

    • Optional Readonly footers

    footers?: { default?: Footer; even?: Footer; first?: Footer }
    @@ -49,7 +51,7 @@
  • Optional Readonly first?: Footer
    • +
  • Defined in src/file/file.ts:30

    • Optional Readonly headers

    headers?: { default?: Header; even?: Header; first?: Header }
    @@ -63,12 +65,12 @@
  • Optional Readonly first?: Header
    • +
  • Defined in src/file/file.ts:25

    • Optional Readonly properties

    properties?: ISectionPropertiesOptions
    +
  • Defined in src/file/file.ts:35
    • diff --git a/api/interfaces/ISectionPropertiesOptions.html b/api/interfaces/ISectionPropertiesOptions.html index 4998dfdbe6..96b4666888 100644 --- a/api/interfaces/ISectionPropertiesOptions.html +++ b/api/interfaces/ISectionPropertiesOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ISectionPropertiesOptions
    +
  • ISectionPropertiesOptions
    • @@ -40,27 +42,27 @@

    Optional Readonly column

    column?: IColumnsAttributes
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:41

    • Optional Readonly footerWrapperGroup

    footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:37

    • Optional Readonly grid

    grid?: IDocGridAttributesProperties
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:35

    • Optional Readonly headerWrapperGroup

    headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:36

    • Optional Readonly lineNumbers

    lineNumbers?: ILineNumberAttributes
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:38

    • Optional Readonly page

    page?: { borders?: IPageBordersOptions; margin?: IPageMarginAttributes; pageNumbers?: IPageNumberTypeAttributes; size?: IPageSizeAttributes; textDirection?: PageTextDirectionType }
    @@ -78,22 +80,22 @@
  • Optional Readonly textDirection?: PageTextDirectionType
    • +
  • Defined in src/file/document/body/section-properties/section-properties.ts:28

    • Optional Readonly titlePage

    titlePage?: boolean
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:39

    • Optional Readonly type

    type?: SectionType
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:42

    • Optional Readonly verticalAlign

    verticalAlign?: VerticalAlign
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:40
    • diff --git a/api/interfaces/IShadingAttributesProperties.html b/api/interfaces/IShadingAttributesProperties.html index 3b06f84d1c..6c676e85c0 100644 --- a/api/interfaces/IShadingAttributesProperties.html +++ b/api/interfaces/IShadingAttributesProperties.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IShadingAttributesProperties
    +
  • IShadingAttributesProperties
    • @@ -34,17 +36,17 @@

    Optional Readonly color

    color?: string
    +
  • Defined in src/file/shading/shading.ts:25

    • Optional Readonly fill

    fill?: string
    +
  • Defined in src/file/shading/shading.ts:24

    • Optional Readonly type

    type?: ShadingType
    +
  • Defined in src/file/shading/shading.ts:26
    • diff --git a/api/interfaces/ISpacingProperties.html b/api/interfaces/ISpacingProperties.html index 57f282eee4..e4e91347e6 100644 --- a/api/interfaces/ISpacingProperties.html +++ b/api/interfaces/ISpacingProperties.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ISpacingProperties
    +
  • ISpacingProperties
    • @@ -37,32 +39,32 @@

    Optional Readonly after

    after?: number
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:10

    • Optional Readonly afterAutoSpacing

    afterAutoSpacing?: boolean
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:15

    • Optional Readonly before

    before?: number
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:11

    • Optional Readonly beforeAutoSpacing

    beforeAutoSpacing?: boolean
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:14

    • Optional Readonly line

    line?: number
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:12

    • Optional Readonly lineRule

    lineRule?: LineRuleType
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:13
    • diff --git a/api/interfaces/IStylesOptions.html b/api/interfaces/IStylesOptions.html index 489b442631..cf83be9037 100644 --- a/api/interfaces/IStylesOptions.html +++ b/api/interfaces/IStylesOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IStylesOptions
    +
  • IStylesOptions
    • @@ -36,27 +38,27 @@

    Optional Readonly characterStyles

    characterStyles?: ICharacterStyleOptions[]
    +
  • Defined in src/file/styles/styles.ts:11

    • Optional Readonly default

    default?: IDefaultStylesOptions
    +
  • Defined in src/file/styles/styles.ts:8

    • Optional Readonly importedStyles

    importedStyles?: (XmlComponent | StyleForParagraph | StyleForCharacter | ImportedXmlComponent)[]
    +
  • Defined in src/file/styles/styles.ts:12

    • Optional Readonly initialStyles

    initialStyles?: BaseXmlComponent
    +
  • Defined in src/file/styles/styles.ts:9

    • Optional Readonly paragraphStyles

    paragraphStyles?: IParagraphStyleOptions[]
    +
  • Defined in src/file/styles/styles.ts:10
    • diff --git a/api/interfaces/ISymbolRunOptions.html b/api/interfaces/ISymbolRunOptions.html index a48804181f..76ee7be803 100644 --- a/api/interfaces/ISymbolRunOptions.html +++ b/api/interfaces/ISymbolRunOptions.html @@ -18,7 +18,9 @@ +
  • ISymbolRunOptions
    • @@ -66,66 +68,66 @@
    allCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:35

    • Optional Readonly bold

    bold?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:19

    • Optional Readonly boldComplexScript

    boldComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:20

    • Optional Readonly border

    border?: IBorderOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:48

    • Optional Readonly break

    break?: number
    +
  • Defined in src/file/paragraph/run/run.ts:16

    • Readonly char

    char: string
    +
  • Defined in src/file/paragraph/run/symbol-run.ts:5

    • Optional Readonly characterSpacing

    characterSpacing?: number
    +
  • Defined in src/file/paragraph/run/properties.ts:43

    • Optional Readonly children

    children?: (string | FootnoteReferenceRun | FieldInstruction | Begin | Separate | End)[]
    +
  • Defined in src/file/paragraph/run/run.ts:15

    • Optional Readonly color

    color?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:30

    • Optional Readonly doubleStrike

    doubleStrike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:37

    • Optional Readonly emboss

    emboss?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:45

    • Optional Readonly emphasisMark

    emphasisMark?: { type?: DOT }
    @@ -136,120 +138,120 @@
    Optional Readonly type?: DOT
    +
  • Defined in src/file/paragraph/run/properties.ts:27

    • Optional Readonly font

    font?: string | IFontAttributesProperties | IFontOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:40

    • Optional Readonly highlight

    highlight?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:41

    • Optional Readonly highlightComplexScript

    highlightComplexScript?: string | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:42

    • Optional Readonly imprint

    imprint?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:46

    • Optional Readonly italics

    italics?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:21

    • Optional Readonly italicsComplexScript

    italicsComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:22

    • Optional Readonly revision

    revision?: IRunPropertiesChangeOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:47

    • Optional Readonly rightToLeft

    rightToLeft?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:33

    • Optional Readonly shading

    shading?: IShadingAttributesProperties
    +
  • Defined in src/file/paragraph/run/properties.ts:44

    • Optional Readonly size

    size?: string | number
    +
  • Defined in src/file/paragraph/run/properties.ts:31

    • Optional Readonly sizeComplexScript

    sizeComplexScript?: string | number | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:32

    • Optional Readonly smallCaps

    smallCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:34

    • Optional Readonly space

    space?: SpaceType
    +
  • Defined in src/file/paragraph/run/properties.ts:49

    • Optional Readonly strike

    strike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:36

    • Optional Readonly style

    style?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:53

    • Optional Readonly subScript

    subScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:38

    • Optional Readonly superScript

    superScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:39

    • Optional Readonly symbolfont

    symbolfont?: string
    +
  • Defined in src/file/paragraph/run/symbol-run.ts:6

    • Optional Readonly text

    text?: string
    +
  • Defined in src/file/paragraph/run/run.ts:17

    • Optional Readonly underline

    underline?: { color?: string; type?: UnderlineType }
    @@ -262,7 +264,7 @@
    Optional Readonly type?: UnderlineType
    +
  • Defined in src/file/paragraph/run/properties.ts:23
    • diff --git a/api/interfaces/ITableBordersOptions.html b/api/interfaces/ITableBordersOptions.html index 94b2c078eb..63d9ad7feb 100644 --- a/api/interfaces/ITableBordersOptions.html +++ b/api/interfaces/ITableBordersOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ITableBordersOptions
    +
  • ITableBordersOptions
    • @@ -37,32 +39,32 @@

    Optional Readonly bottom

    bottom?: IBorderOptions
    +
  • Defined in src/file/table/table-properties/table-borders.ts:7

    • Optional Readonly insideHorizontal

    insideHorizontal?: IBorderOptions
    +
  • Defined in src/file/table/table-properties/table-borders.ts:10

    • Optional Readonly insideVertical

    insideVertical?: IBorderOptions
    +
  • Defined in src/file/table/table-properties/table-borders.ts:11

    • Optional Readonly left

    left?: IBorderOptions
    +
  • Defined in src/file/table/table-properties/table-borders.ts:8

    • Optional Readonly right

    right?: IBorderOptions
    +
  • Defined in src/file/table/table-properties/table-borders.ts:9

    • Optional Readonly top

    top?: IBorderOptions
    +
  • Defined in src/file/table/table-properties/table-borders.ts:6
    • diff --git a/api/interfaces/ITableCellBorders.html b/api/interfaces/ITableCellBorders.html index bb367ad23e..1adb1a5a4d 100644 --- a/api/interfaces/ITableCellBorders.html +++ b/api/interfaces/ITableCellBorders.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ITableCellBorders
    +
  • ITableCellBorders
    • @@ -37,32 +39,32 @@

    Optional Readonly bottom

    bottom?: IBorderOptions
    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:24

    • Optional Readonly end

    end?: IBorderOptions
    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:25

    • Optional Readonly left

    left?: IBorderOptions
    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:23

    • Optional Readonly right

    right?: IBorderOptions
    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:26

    • Optional Readonly start

    start?: IBorderOptions
    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:22

    • Optional Readonly top

    top?: IBorderOptions
    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:21
    • diff --git a/api/interfaces/ITableCellOptions.html b/api/interfaces/ITableCellOptions.html index 5c3c7eeca4..c6646551b6 100644 --- a/api/interfaces/ITableCellOptions.html +++ b/api/interfaces/ITableCellOptions.html @@ -18,7 +18,9 @@
    • ITableCellPropertiesOptions
        -
      • ITableCellOptions
    +
  • ITableCellOptions
    • @@ -44,60 +46,60 @@
    borders?: ITableCellBorders
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:26

    • Readonly children

    children: (Paragraph | Table)[]
    +
  • Defined in src/file/table/table-cell/table-cell.ts:9

    • Optional Readonly columnSpan

    columnSpan?: number
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:24

    • Optional Readonly margins

    margins?: ITableCellMarginOptions
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:19

    • Optional Readonly rowSpan

    rowSpan?: number
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:25

    • Optional Readonly shading

    shading?: IShadingAttributesProperties
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:18

    • Optional Readonly textDirection

    textDirection?: TextDirection
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:21

    • Optional Readonly verticalAlign

    verticalAlign?: VerticalAlign
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:20

    • Optional Readonly verticalMerge

    verticalMerge?: VerticalMergeType
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:22

    • Optional Readonly width

    width?: ITableWidthProperties
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:23
    • diff --git a/api/interfaces/ITableFloatOptions.html b/api/interfaces/ITableFloatOptions.html index 61b0e609ce..d853880a83 100644 --- a/api/interfaces/ITableFloatOptions.html +++ b/api/interfaces/ITableFloatOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ITableFloatOptions
    +
  • ITableFloatOptions
    • @@ -48,7 +50,7 @@ If relativeHorizontalPosition is also specified, then the absoluteHorizontalPosi If the attribute is omitted, the value is assumed to be zero.

    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:49

    • Optional Readonly absoluteVerticalPosition

    absoluteVerticalPosition?: string | number
    @@ -59,7 +61,7 @@ If relativeVerticalPosition is also specified, then the absoluteVerticalPosition If the attribute is omitted, the value is assumed to be zero.

    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:80

    • Optional Readonly bottomFromText

    bottomFromText?: string | number
    @@ -67,7 +69,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 horizontalAnchor

    horizontalAnchor?: TableAnchorType
    @@ -79,7 +81,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 leftFromText

    leftFromText?: string | number
    @@ -87,12 +89,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

    overlap?: OverlapType
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:117

    • Optional Readonly relativeHorizontalPosition

    relativeHorizontalPosition?: RelativeHorizontalPosition
    @@ -106,7 +108,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 relativeVerticalPosition

    relativeVerticalPosition?: RelativeVerticalPosition
    @@ -120,7 +122,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 rightFromText

    rightFromText?: string | number
    @@ -128,7 +130,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 topFromText

    topFromText?: string | number
    @@ -136,7 +138,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 verticalAnchor

    verticalAnchor?: TableAnchorType
    @@ -148,7 +150,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
    • diff --git a/api/interfaces/ITableOfContentsOptions.html b/api/interfaces/ITableOfContentsOptions.html index 90e74bf001..cd5b26abd9 100644 --- a/api/interfaces/ITableOfContentsOptions.html +++ b/api/interfaces/ITableOfContentsOptions.html @@ -23,7 +23,9 @@ Part 1 - Page 1251

    Hierarchy

      -
    • ITableOfContentsOptions
    +
  • ITableOfContentsOptions
    • @@ -58,7 +60,7 @@ The identifier designated by text in this switch's field-argument correspond Use captionLabelIncludingNumbers (\c) to build a table of captions with labels and numbers.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:25

    • Optional Readonly captionLabelIncludingNumbers

    captionLabelIncludingNumbers?: string
    @@ -68,7 +70,7 @@ field-argument, which corresponds to the caption label, shall match the identifi corresponding SEQ field.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:39

    • Optional Readonly entriesFromBookmark

    entriesFromBookmark?: string
    @@ -76,7 +78,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 entryAndPageNumberSeparator

    entryAndPageNumberSeparator?: string
    @@ -84,7 +86,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 headingStyleRange

    headingStyleRange?: string
    @@ -95,21 +97,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 hideTabAndPageNumbersInWebView

    hideTabAndPageNumbersInWebView?: boolean

    \z Hides tab leader and page numbers in web page view (§17.18.102).

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:121

    • Optional Readonly hyperlink

    hyperlink?: boolean

    \h option - Makes the table of contents entries hyperlinks.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:56

    • Optional Readonly pageNumbersEntryLevelsRange

    pageNumbersEntryLevelsRange?: string
    @@ -118,21 +120,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 preserveNewLineInEntries

    preserveNewLineInEntries?: boolean

    \x Preserves newline characters within table entries.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:116

    • Optional Readonly preserveTabInEntries

    preserveTabInEntries?: boolean

    \w Preserves tab entries within table entries.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:111

    • Optional Readonly seqFieldIdentifierForPrefix

    seqFieldIdentifierForPrefix?: string
    @@ -141,7 +143,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 sequenceAndPageNumbersSeparator

    sequenceAndPageNumbersSeparator?: string
    @@ -149,7 +151,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 stylesWithLevels

    stylesWithLevels?: StyleLevel[]
    @@ -159,7 +161,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 tcFieldIdentifier

    tcFieldIdentifier?: string
    @@ -167,7 +169,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 tcFieldLevelRange

    tcFieldLevelRange?: string
    @@ -177,14 +179,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 useAppliedParagraphOutlineLevel

    useAppliedParagraphOutlineLevel?: boolean

    \u Uses the applied paragraph outline level.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:106
    • diff --git a/api/interfaces/ITableOptions.html b/api/interfaces/ITableOptions.html index be7c2cfe3c..f3813e78c4 100644 --- a/api/interfaces/ITableOptions.html +++ b/api/interfaces/ITableOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ITableOptions
    +
  • ITableOptions
    • @@ -42,57 +44,57 @@

    Optional Readonly alignment

    alignment?: AlignmentType
    +
  • Defined in src/file/table/table.ts:33

    • Optional Readonly borders

    borders?: ITableBordersOptions
    +
  • Defined in src/file/table/table.ts:32

    • Optional Readonly columnWidths

    columnWidths?: number[]
    +
  • Defined in src/file/table/table.ts:26

    • Optional Readonly float

    float?: ITableFloatOptions
    +
  • Defined in src/file/table/table.ts:29

    • Optional Readonly indent

    indent?: ITableWidthProperties
    +
  • Defined in src/file/table/table.ts:28

    • Optional Readonly layout

    layout?: TableLayoutType
    +
  • Defined in src/file/table/table.ts:30

    • Optional Readonly margins

    margins?: ITableCellMarginOptions
    +
  • Defined in src/file/table/table.ts:27

    • Readonly rows

    rows: TableRow[]
    +
  • Defined in src/file/table/table.ts:24

    • Optional Readonly style

    style?: string
    +
  • Defined in src/file/table/table.ts:31

    • Optional Readonly visuallyRightToLeft

    visuallyRightToLeft?: boolean
    +
  • Defined in src/file/table/table.ts:34

    • Optional Readonly width

    width?: ITableWidthProperties
    +
  • Defined in src/file/table/table.ts:25
    • diff --git a/api/interfaces/ITablePropertiesOptions.html b/api/interfaces/ITablePropertiesOptions.html index 138541088c..ce68c6e452 100644 --- a/api/interfaces/ITablePropertiesOptions.html +++ b/api/interfaces/ITablePropertiesOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ITablePropertiesOptions
    +
  • ITablePropertiesOptions
    • @@ -41,52 +43,52 @@

    Optional Readonly alignment

    alignment?: AlignmentType
    +
  • Defined in src/file/table/table-properties/table-properties.ts:42

    • Optional Readonly borders

    borders?: ITableBordersOptions
    +
  • Defined in src/file/table/table-properties/table-properties.ts:38

    • Optional Readonly cellMargin

    cellMargin?: ITableCellMarginOptions
    +
  • Defined in src/file/table/table-properties/table-properties.ts:43

    • Optional Readonly float

    float?: ITableFloatOptions
    +
  • Defined in src/file/table/table-properties/table-properties.ts:39

    • Optional Readonly indent

    indent?: ITableWidthProperties
    +
  • Defined in src/file/table/table-properties/table-properties.ts:36

    • Optional Readonly layout

    layout?: TableLayoutType
    +
  • Defined in src/file/table/table-properties/table-properties.ts:37

    • Optional Readonly shading

    shading?: IShadingAttributesProperties
    +
  • Defined in src/file/table/table-properties/table-properties.ts:40

    • Optional Readonly style

    style?: string
    +
  • Defined in src/file/table/table-properties/table-properties.ts:41

    • Optional Readonly visuallyRightToLeft

    visuallyRightToLeft?: boolean
    +
  • Defined in src/file/table/table-properties/table-properties.ts:44

    • Optional Readonly width

    width?: ITableWidthProperties
    +
  • Defined in src/file/table/table-properties/table-properties.ts:35
    • diff --git a/api/interfaces/ITableRowOptions.html b/api/interfaces/ITableRowOptions.html index a22fb00c4e..dfcaffdbda 100644 --- a/api/interfaces/ITableRowOptions.html +++ b/api/interfaces/ITableRowOptions.html @@ -18,7 +18,9 @@ +
  • ITableRowOptions
    • @@ -38,12 +40,12 @@
    cantSplit?: boolean
    +
  • Defined in src/file/table/table-row/table-row-properties.ts:35

    • Readonly children

    children: TableCell[]
    +
  • Defined in src/file/table/table-row/table-row.ts:6

    • Optional Readonly height

    height?: { rule: HeightRule; value: string | number }
    @@ -56,13 +58,13 @@
    Readonly value: string | number
    +
  • Defined in src/file/table/table-row/table-row-properties.ts:37

    • Optional Readonly tableHeader

    tableHeader?: boolean
    +
  • Defined in src/file/table/table-row/table-row-properties.ts:36
    • diff --git a/api/interfaces/ITableRowPropertiesOptions.html b/api/interfaces/ITableRowPropertiesOptions.html index bf4ddafae2..ed248b3735 100644 --- a/api/interfaces/ITableRowPropertiesOptions.html +++ b/api/interfaces/ITableRowPropertiesOptions.html @@ -18,7 +18,9 @@ +
  • ITableRowOptions
    • @@ -36,7 +38,7 @@

    Optional Readonly cantSplit

    cantSplit?: boolean
    +
  • Defined in src/file/table/table-row/table-row-properties.ts:35

    • Optional Readonly height

    height?: { rule: HeightRule; value: string | number }
    @@ -48,12 +50,12 @@
  • Readonly value: string | number
    • +
  • Defined in src/file/table/table-row/table-row-properties.ts:37

    • Optional Readonly tableHeader

    tableHeader?: boolean
    +
  • Defined in src/file/table/table-row/table-row-properties.ts:36
    • diff --git a/api/interfaces/ITableWidthProperties.html b/api/interfaces/ITableWidthProperties.html index 2eb259ce22..c0e5fbf1ac 100644 --- a/api/interfaces/ITableWidthProperties.html +++ b/api/interfaces/ITableWidthProperties.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ITableWidthProperties
    +
  • ITableWidthProperties
    • @@ -33,12 +35,12 @@

    Readonly size

    size: string | number
    +
  • Defined in src/file/table/table-width.ts:29

    • Optional Readonly type

    type?: WidthType
    +
  • Defined in src/file/table/table-width.ts:30
    • diff --git a/api/interfaces/ITextWrapping.html b/api/interfaces/ITextWrapping.html index 8c3df0d946..c602df5b02 100644 --- a/api/interfaces/ITextWrapping.html +++ b/api/interfaces/ITextWrapping.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • ITextWrapping
    +
  • ITextWrapping
    • @@ -34,17 +36,17 @@

    Optional Readonly margins

    margins?: IDistance
    +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:21

    • Optional Readonly side

    side?: TextWrappingSide
    +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:20

    • Readonly type

    type: TextWrappingType
    +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:19
    • diff --git a/api/interfaces/IVerticalPositionOptions.html b/api/interfaces/IVerticalPositionOptions.html index b6a79c8f36..7b002b044a 100644 --- a/api/interfaces/IVerticalPositionOptions.html +++ b/api/interfaces/IVerticalPositionOptions.html @@ -16,7 +16,9 @@

    Hierarchy

      -
    • IVerticalPositionOptions
    +
  • IVerticalPositionOptions
    • @@ -34,17 +36,17 @@

    Optional Readonly align

    align?: VerticalPositionAlign
    +
  • Defined in src/file/drawing/floating/floating-position.ts:37

    • Optional Readonly offset

    offset?: number
    +
  • Defined in src/file/drawing/floating/floating-position.ts:38

    • Optional Readonly relative

    relative?: VerticalPositionRelativeFrom
    +
  • Defined in src/file/drawing/floating/floating-position.ts:36
    • diff --git a/api/interfaces/IXYFrameOptions.html b/api/interfaces/IXYFrameOptions.html index 2e78e7638a..b1bc0af769 100644 --- a/api/interfaces/IXYFrameOptions.html +++ b/api/interfaces/IXYFrameOptions.html @@ -18,7 +18,9 @@
    • IBaseFrameOptions
        -
      • IXYFrameOptions
    +
  • IXYFrameOptions
    • @@ -51,31 +53,31 @@
    Readonly vertical: FrameAnchorType
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:34

    • Optional Readonly anchorLock

    anchorLock?: boolean
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:28

    • Optional Readonly dropCap

    dropCap?: DropCapType
    +
  • 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

    • Readonly position

    position: { x: number; y: number }
    @@ -87,13 +89,13 @@
  • Readonly y: number
    • +
  • Defined in src/file/paragraph/frame/frame-properties.ts:46

    • Optional Readonly rule

    rule?: HeightRule
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:42

    • Optional Readonly space

    space?: { horizontal: number; vertical: number }
    @@ -106,19 +108,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

    • Optional Readonly wrap

    wrap?: FrameWrap
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:32
    • diff --git a/api/interfaces/IXmlAttribute.html b/api/interfaces/IXmlAttribute.html index a6ca4bb7ef..ec2769769c 100644 --- a/api/interfaces/IXmlAttribute.html +++ b/api/interfaces/IXmlAttribute.html @@ -19,7 +19,9 @@
  • IXmlAttribute

    • Indexable

    -
    [key: string]: string | number | boolean
    +
    [key: string]: string | number | boolean
    diff --git a/api/interfaces/IXmlableObject.html b/api/interfaces/IXmlableObject.html index 1002a3d6c0..608f5b01df 100644 --- a/api/interfaces/IXmlableObject.html +++ b/api/interfaces/IXmlableObject.html @@ -18,7 +18,9 @@
    • Object
        -
      • IXmlableObject
    +
  • IXmlableObject
    • @@ -45,7 +47,7 @@

    Optional Readonly _attr

    _attr?: IXmlAttribute
    +
  • Defined in src/file/xml-components/xmlable-object.ts:5

    • constructor

    constructor: Function
    @@ -77,7 +79,9 @@

    A property name.

    Returns boolean

    +

    Inherited from Object.hasOwnProperty

    +

    isPrototypeOf

      @@ -93,7 +97,9 @@

      Another object whose prototype chain is to be checked.

    Returns boolean

    +

    Inherited from Object.isPrototypeOf

    +

    propertyIsEnumerable

    Returns boolean

    +

    Inherited from Object.propertyIsEnumerable

    +

    toLocaleString

    +

    Inherited from Object.toLocaleString

    +

    toString

    +

    Inherited from Object.toString

    +

    valueOf

    +

    Inherited from Object.valueOf

    +
    diff --git a/api/types/AttributeMap.html b/api/types/AttributeMap.html index f1682cc5f9..c77ef34734 100644 --- a/api/types/AttributeMap.html +++ b/api/types/AttributeMap.html @@ -19,7 +19,7 @@

  • T

    • +
  • Defined in src/file/xml-components/default-attributes.ts:4
    • diff --git a/api/types/IFrameOptions.html b/api/types/IFrameOptions.html index e46f42fbd6..e6871977bc 100644 --- a/api/types/IFrameOptions.html +++ b/api/types/IFrameOptions.html @@ -15,7 +15,7 @@

    Type alias IFrameOptions

    IFrameOptions: IXYFrameOptions | IAlignmentFrameOptions
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:61
    • diff --git a/api/types/MathComponent.html b/api/types/MathComponent.html index 633087add5..08292de09f 100644 --- a/api/types/MathComponent.html +++ b/api/types/MathComponent.html @@ -15,7 +15,7 @@

    Type alias MathComponent

    MathComponent: MathRun | MathFraction | MathSum | MathSuperScript | MathSubScript | MathSubSuperScript | MathRadical | MathFunction | MathRoundBrackets | MathCurlyBrackets | MathAngledBrackets | MathSquareBrackets
    +
  • Defined in src/file/paragraph/math/math-component.ts:9
    • diff --git a/api/types/ParagraphChild.html b/api/types/ParagraphChild.html index bf297a9aeb..2427917f26 100644 --- a/api/types/ParagraphChild.html +++ b/api/types/ParagraphChild.html @@ -15,7 +15,7 @@

    Type alias ParagraphChild

    ParagraphChild: TextRun | ImageRun | SymbolRun | Bookmark | PageBreak | ColumnBreak | SequentialIdentifier | FootnoteReferenceRun | InternalHyperlink | ExternalHyperlink | InsertedTextRun | DeletedTextRun | Math | SimpleField | SimpleMailMergeField | Comments | Comment | CommentRangeStart | CommentRangeEnd | CommentReference
    +
  • Defined in src/file/paragraph/paragraph.ts:15
    • diff --git a/api/variables/EMPTY_OBJECT.html b/api/variables/EMPTY_OBJECT.html index 80e211dc7a..3ab07aa7be 100644 --- a/api/variables/EMPTY_OBJECT.html +++ b/api/variables/EMPTY_OBJECT.html @@ -18,7 +18,7 @@

    Type declaration

      +
    • Defined in src/file/xml-components/xml-component.ts:4
      • diff --git a/api/variables/sectionMarginDefaults.html b/api/variables/sectionMarginDefaults.html index 1cf5230da3..af8fb7357c 100644 --- a/api/variables/sectionMarginDefaults.html +++ b/api/variables/sectionMarginDefaults.html @@ -32,7 +32,7 @@
    • TOP: string
      • +
    • Defined in src/file/document/body/section-properties/section-properties.ts:78
      • diff --git a/api/variables/sectionPageSizeDefaults.html b/api/variables/sectionPageSizeDefaults.html index 728ced8417..26e0bddc2c 100644 --- a/api/variables/sectionPageSizeDefaults.html +++ b/api/variables/sectionPageSizeDefaults.html @@ -24,7 +24,7 @@
    • WIDTH: number
      • +
    • Defined in src/file/document/body/section-properties/section-properties.ts:88