From cd3c1bbf0455daeb823a6c203e56206d3abc6804 Mon Sep 17 00:00:00 2001 From: dolanmiu Date: Mon, 25 Dec 2023 12:39:10 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20dolanmiu?= =?UTF-8?q?/docx@62ad8f12b7eb7b8b49515772dec5c4fcdd892f90=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api/classes/AbstractNumbering.html | 6 ++-- api/classes/Alignment.html | 6 ++-- api/classes/AlignmentAttributes.html | 4 +-- api/classes/AnnotationReference.html | 6 ++-- api/classes/Attributes.html | 4 +-- api/classes/BaseEmphasisMark.html | 4 +-- api/classes/BaseXmlComponent.html | 4 +-- api/classes/Body.html | 8 ++--- api/classes/Bookmark.html | 4 +-- api/classes/BookmarkEnd.html | 6 ++-- api/classes/BookmarkStart.html | 6 ++-- api/classes/Border.html | 6 ++-- api/classes/BorderElement.html | 6 ++-- api/classes/BuilderElement.html | 6 ++-- api/classes/CarriageReturn.html | 6 ++-- api/classes/CheckBox.html | 6 ++-- api/classes/CheckBoxSymbolElement.html | 6 ++-- api/classes/CheckBoxUtil.html | 6 ++-- api/classes/Column.html | 6 ++-- api/classes/ColumnBreak.html | 6 ++-- api/classes/Columns.html | 6 ++-- api/classes/Comment.html | 6 ++-- api/classes/CommentRangeEnd.html | 6 ++-- api/classes/CommentRangeStart.html | 6 ++-- api/classes/CommentReference.html | 6 ++-- api/classes/Comments.html | 6 ++-- api/classes/ConcreteHyperlink.html | 6 ++-- api/classes/ConcreteNumbering.html | 6 ++-- api/classes/ContinuationSeparator.html | 6 ++-- api/classes/DayLong.html | 6 ++-- api/classes/DayShort.html | 6 ++-- api/classes/DeletedTextRun.html | 6 ++-- api/classes/DocGridAttributes.html | 4 +-- api/classes/Document.html | 4 +-- api/classes/DocumentAttributes.html | 4 +-- api/classes/DocumentBackground.html | 6 ++-- api/classes/DocumentBackgroundAttributes.html | 4 +-- api/classes/DocumentDefaults.html | 6 ++-- api/classes/DocumentGrid.html | 6 ++-- api/classes/DotEmphasisMark.html | 6 ++-- api/classes/Drawing.html | 6 ++-- api/classes/EmphasisMark.html | 6 ++-- api/classes/EmptyElement.html | 6 ++-- api/classes/EndnoteReference.html | 6 ++-- api/classes/ExternalHyperlink.html | 6 ++-- .../FootNoteReferenceRunAttributes.html | 4 +-- api/classes/FootNotes.html | 6 ++-- api/classes/Footer.html | 4 +-- api/classes/FooterWrapper.html | 4 +-- api/classes/FootnoteReference.html | 6 ++-- api/classes/FootnoteReferenceElement.html | 6 ++-- api/classes/FootnoteReferenceRun.html | 6 ++-- api/classes/FrameProperties.html | 6 ++-- api/classes/FramePropertiesAttributes.html | 4 +-- api/classes/GridSpan.html | 6 ++-- api/classes/Header.html | 4 +-- api/classes/HeaderFooterReference.html | 6 ++-- api/classes/HeaderWrapper.html | 4 +-- api/classes/HorizontalPosition.html | 6 ++-- api/classes/HpsMeasureElement.html | 6 ++-- api/classes/IgnoreIfEmptyXmlComponent.html | 6 ++-- api/classes/ImageRun.html | 6 ++-- .../ImportedRootElementAttributes.html | 6 ++-- api/classes/ImportedXmlComponent.html | 8 ++--- api/classes/Indent.html | 6 ++-- api/classes/InitializableXmlComponent.html | 6 ++-- api/classes/InsertedTextRun.html | 6 ++-- api/classes/InternalHyperlink.html | 6 ++-- api/classes/LastRenderedPageBreak.html | 6 ++-- api/classes/Level.html | 6 ++-- api/classes/LevelBase.html | 6 ++-- api/classes/LevelForOverride.html | 6 ++-- api/classes/LevelOverride.html | 6 ++-- api/classes/Math.html | 6 ++-- api/classes/MathAccentCharacter.html | 6 ++-- api/classes/MathAngledBrackets.html | 6 ++-- api/classes/MathBase.html | 6 ++-- api/classes/MathCurlyBrackets.html | 6 ++-- api/classes/MathDegree.html | 6 ++-- api/classes/MathDenominator.html | 6 ++-- api/classes/MathFraction.html | 6 ++-- api/classes/MathFunction.html | 6 ++-- api/classes/MathFunctionName.html | 6 ++-- api/classes/MathFunctionProperties.html | 6 ++-- api/classes/MathIntegral.html | 6 ++-- api/classes/MathLimitLocation.html | 6 ++-- api/classes/MathNAryProperties.html | 6 ++-- api/classes/MathNumerator.html | 6 ++-- api/classes/MathPreSubSuperScript.html | 6 ++-- .../MathPreSubSuperScriptProperties.html | 6 ++-- api/classes/MathRadical.html | 6 ++-- api/classes/MathRadicalProperties.html | 6 ++-- api/classes/MathRoundBrackets.html | 6 ++-- api/classes/MathRun.html | 6 ++-- api/classes/MathSquareBrackets.html | 6 ++-- api/classes/MathSubScript.html | 6 ++-- api/classes/MathSubScriptElement.html | 6 ++-- api/classes/MathSubScriptProperties.html | 6 ++-- api/classes/MathSubSuperScript.html | 6 ++-- api/classes/MathSubSuperScriptProperties.html | 6 ++-- api/classes/MathSum.html | 6 ++-- api/classes/MathSuperScript.html | 6 ++-- api/classes/MathSuperScriptElement.html | 6 ++-- api/classes/MathSuperScriptProperties.html | 6 ++-- api/classes/Media.html | 4 +-- api/classes/MonthLong.html | 6 ++-- api/classes/MonthShort.html | 6 ++-- api/classes/NextAttributeComponent.html | 4 +-- api/classes/NoBreakHyphen.html | 6 ++-- api/classes/NumberProperties.html | 6 ++-- api/classes/NumberValueElement.html | 6 ++-- api/classes/Numbering.html | 6 ++-- api/classes/OnOffElement.html | 6 ++-- api/classes/OutlineLevel.html | 6 ++-- api/classes/Packer.html | 4 +-- api/classes/PageBorders.html | 6 ++-- api/classes/PageBreak.html | 6 ++-- api/classes/PageBreakBefore.html | 6 ++-- api/classes/PageMargin.html | 6 ++-- api/classes/PageNumberElement.html | 6 ++-- api/classes/PageNumberType.html | 6 ++-- api/classes/PageNumberTypeAttributes.html | 4 +-- api/classes/PageReference.html | 6 ++-- api/classes/PageSize.html | 6 ++-- api/classes/PageTextDirection.html | 6 ++-- api/classes/Paragraph.html | 6 ++-- api/classes/ParagraphProperties.html | 6 ++-- api/classes/ParagraphPropertiesDefaults.html | 6 ++-- api/classes/PositionalTab.html | 6 ++-- api/classes/Run.html | 6 ++-- api/classes/RunFonts.html | 6 ++-- api/classes/RunProperties.html | 6 ++-- api/classes/RunPropertiesChange.html | 6 ++-- api/classes/RunPropertiesDefaults.html | 6 ++-- api/classes/SectionProperties.html | 6 ++-- api/classes/SectionTypeAttributes.html | 4 +-- api/classes/Separator.html | 6 ++-- api/classes/SequentialIdentifier.html | 6 ++-- api/classes/Shading.html | 6 ++-- api/classes/SimpleField.html | 6 ++-- api/classes/SimpleMailMergeField.html | 6 ++-- api/classes/SimplePos.html | 6 ++-- api/classes/SoftHyphen.html | 6 ++-- api/classes/Spacing.html | 6 ++-- api/classes/StringContainer.html | 6 ++-- api/classes/StringEnumValueElement.html | 6 ++-- api/classes/StringValueElement.html | 6 ++-- api/classes/Style.html | 6 ++-- api/classes/StyleForCharacter.html | 6 ++-- api/classes/StyleForParagraph.html | 6 ++-- api/classes/StyleLevel.html | 4 +-- api/classes/Styles.html | 6 ++-- api/classes/SymbolRun.html | 6 ++-- api/classes/TDirection.html | 6 ++-- api/classes/Tab.html | 6 ++-- api/classes/TabAttributes.html | 4 +-- api/classes/TabStop.html | 6 ++-- api/classes/TabStopItem.html | 6 ++-- api/classes/Table.html | 6 ++-- api/classes/TableBorders.html | 6 ++-- api/classes/TableCell.html | 6 ++-- api/classes/TableCellBorders.html | 6 ++-- api/classes/TableFloatProperties.html | 6 ++-- api/classes/TableLayout.html | 6 ++-- api/classes/TableOfContents.html | 6 ++-- api/classes/TableProperties.html | 6 ++-- api/classes/TableRow.html | 6 ++-- api/classes/TableRowHeight.html | 6 ++-- api/classes/TableRowHeightAttributes.html | 4 +-- api/classes/TableRowProperties.html | 6 ++-- api/classes/TableWidthElement.html | 6 ++-- api/classes/TextRun.html | 6 ++-- api/classes/ThematicBreak.html | 6 ++-- api/classes/Type.html | 6 ++-- api/classes/Underline.html | 6 ++-- api/classes/VerticalAlignAttributes.html | 4 +-- api/classes/VerticalAlignElement.html | 6 ++-- api/classes/VerticalMerge.html | 6 ++-- api/classes/VerticalPosition.html | 6 ++-- api/classes/WrapNone.html | 6 ++-- api/classes/WrapSquare.html | 6 ++-- api/classes/WrapTight.html | 6 ++-- api/classes/WrapTopAndBottom.html | 6 ++-- api/classes/XmlAttributeComponent.html | 4 +-- api/classes/XmlComponent.html | 6 ++-- api/classes/YearLong.html | 6 ++-- api/classes/YearShort.html | 6 ++-- .../abstractNumUniqueNumericIdGen.html | 2 +- api/functions/bookmarkUniqueNumericIdGen.html | 2 +- .../concreteNumUniqueNumericIdGen.html | 2 +- api/functions/convertInchesToTwip.html | 2 +- api/functions/convertMillimetersToTwip.html | 2 +- api/functions/convertToXmlComponent.html | 2 +- api/functions/createLineNumberType.html | 2 +- api/functions/dateTimeValue.html | 2 +- api/functions/decimalNumber.html | 2 +- .../docPropertiesUniqueNumericIdGen.html | 2 +- api/functions/eighthPointMeasureValue.html | 2 +- api/functions/hexColorValue.html | 2 +- api/functions/hpsMeasureValue.html | 2 +- api/functions/longHexNumber.html | 2 +- api/functions/measurementOrPercentValue.html | 2 +- api/functions/patchDocument.html | 2 +- api/functions/percentageValue.html | 2 +- api/functions/pointMeasureValue.html | 2 +- .../positiveUniversalMeasureValue.html | 2 +- api/functions/shortHexNumber.html | 2 +- api/functions/signedHpsMeasureValue.html | 2 +- api/functions/signedTwipsMeasureValue.html | 2 +- api/functions/twipsMeasureValue.html | 2 +- api/functions/uCharHexNumber.html | 2 +- api/functions/uniqueId.html | 2 +- api/functions/uniqueNumericIdCreator-1.html | 2 +- api/functions/universalMeasureValue.html | 2 +- api/functions/unsignedDecimalNumber.html | 2 +- api/interfaces/IAlignmentFrameOptions.html | 4 +-- .../IBaseCharacterStyleOptions.html | 4 +-- .../IBaseParagraphStyleOptions.html | 4 +-- api/interfaces/IBorderOptions.html | 8 ++--- api/interfaces/IBordersOptions.html | 4 +-- api/interfaces/ICharacterStyleOptions.html | 4 +-- api/interfaces/ICheckboxSymbolOptions.html | 4 +-- api/interfaces/ICheckboxSymbolProperties.html | 4 +-- api/interfaces/ICommentOptions.html | 4 +-- api/interfaces/ICommentsOptions.html | 4 +-- api/interfaces/IConcreteNumberingOptions.html | 4 +-- api/interfaces/IContext.html | 4 +-- api/interfaces/IDistance.html | 4 +-- .../IDocGridAttributesProperties.html | 4 +-- .../IDocumentAttributesProperties.html | 4 +-- .../IDocumentBackgroundOptions.html | 4 +-- api/interfaces/IDocumentDefaultsOptions.html | 4 +-- api/interfaces/IDocumentFooter.html | 4 +-- api/interfaces/IDocumentHeader.html | 4 +-- api/interfaces/IDocumentOptions.html | 4 +-- api/interfaces/IDrawingOptions.html | 4 +-- api/interfaces/IFloating.html | 4 +-- api/interfaces/IFontAttributesProperties.html | 4 +-- api/interfaces/IHeaderFooterGroup.html | 4 +-- api/interfaces/IHeaderFooterOptions.html | 4 +-- api/interfaces/IHeaderOptions.html | 4 +-- .../IHorizontalPositionOptions.html | 4 +-- api/interfaces/IImageOptions.html | 4 +-- .../IIndentAttributesProperties.html | 4 +-- ...ILevelParagraphStylePropertiesOptions.html | 8 ++--- api/interfaces/ILevelsOptions.html | 4 +-- api/interfaces/IMargins.html | 4 +-- api/interfaces/IMathFractionOptions.html | 4 +-- api/interfaces/IMathFunctionOptions.html | 4 +-- api/interfaces/IMathIntegralOptions.html | 4 +-- api/interfaces/IMathOptions.html | 4 +-- .../IMathPreSubSuperScriptOptions.html | 4 +-- api/interfaces/IMathRadicalOptions.html | 4 +-- api/interfaces/IMathSubScriptOptions.html | 4 +-- .../IMathSubSuperScriptOptions.html | 4 +-- api/interfaces/IMathSumOptions.html | 4 +-- api/interfaces/IMathSuperScriptOptions.html | 4 +-- api/interfaces/IMediaData.html | 4 +-- api/interfaces/IMediaDataTransformation.html | 4 +-- api/interfaces/IMediaTransformation.html | 4 +-- api/interfaces/INumberingOptions.html | 4 +-- api/interfaces/IPageBorderAttributes.html | 4 +-- api/interfaces/IPageBordersOptions.html | 4 +-- api/interfaces/IPageNumberTypeAttributes.html | 4 +-- api/interfaces/IParagraphOptions.html | 12 +++---- .../IParagraphPropertiesOptions.html | 12 +++---- api/interfaces/IParagraphStyleOptions.html | 4 +-- .../IParagraphStylePropertiesOptions.html | 8 ++--- api/interfaces/IRunOptions.html | 4 +-- .../IRunPropertiesChangeOptions.html | 4 +-- api/interfaces/IRunPropertiesOptions.html | 4 +-- .../IRunStylePropertiesOptions.html | 4 +-- api/interfaces/ISectionOptions.html | 4 +-- api/interfaces/ISectionPropertiesOptions.html | 4 +-- .../IShadingAttributesProperties.html | 4 +-- api/interfaces/ISpacingProperties.html | 4 +-- api/interfaces/IStylesOptions.html | 4 +-- api/interfaces/ISymbolRunOptions.html | 4 +-- api/interfaces/ITableBordersOptions.html | 4 +-- api/interfaces/ITableCellBorders.html | 4 +-- api/interfaces/ITableCellOptions.html | 4 +-- api/interfaces/ITableOfContentsOptions.html | 34 +++++++++---------- api/interfaces/ITableOptions.html | 4 +-- api/interfaces/ITablePropertiesOptions.html | 4 +-- api/interfaces/ITableRowOptions.html | 4 +-- .../ITableRowPropertiesOptions.html | 4 +-- api/interfaces/ITextWrapping.html | 4 +-- api/interfaces/IVerticalPositionOptions.html | 4 +-- api/interfaces/IXYFrameOptions.html | 4 +-- api/interfaces/IXmlAttribute.html | 2 +- api/interfaces/IXmlableObject.html | 2 +- api/interfaces/PatchDocumentOptions.html | 4 +-- api/interfaces/PositionalTabOptions.html | 4 +-- api/interfaces/TabStopDefinition.html | 4 +-- api/types/AttributeData.html | 2 +- api/types/AttributeMap.html | 2 +- api/types/AttributePayload.html | 2 +- api/types/IColumnsAttributes.html | 2 +- api/types/IFrameOptions.html | 2 +- api/types/ILineNumberAttributes.html | 2 +- api/types/IPageMarginAttributes.html | 2 +- api/types/IPageReferenceOptions.html | 2 +- api/types/IPageSizeAttributes.html | 2 +- api/types/IPatch.html | 2 +- api/types/ITableFloatOptions.html | 2 +- api/types/ITableWidthProperties.html | 2 +- api/types/MathComponent.html | 2 +- api/types/ParagraphChild.html | 2 +- api/types/Percentage.html | 2 +- api/types/PositiveUniversalMeasure.html | 2 +- api/types/UniqueNumericIdCreator.html | 2 +- api/types/UniversalMeasure.html | 2 +- api/variables/AlignmentType.html | 2 +- api/variables/BorderStyle.html | 2 +- api/variables/DocumentGridType.html | 2 +- api/variables/DropCapType.html | 2 +- api/variables/EMPTY_OBJECT.html | 2 +- api/variables/EmphasisMarkType.html | 2 +- api/variables/FrameAnchorType.html | 2 +- api/variables/FrameWrap.html | 2 +- api/variables/HeaderFooterReferenceType.html | 2 +- api/variables/HeaderFooterType.html | 2 +- api/variables/HeadingLevel.html | 2 +- api/variables/HeightRule.html | 2 +- api/variables/HorizontalPositionAlign.html | 2 +- .../HorizontalPositionRelativeFrom.html | 2 +- api/variables/HyperlinkType.html | 2 +- api/variables/LeaderType.html | 2 +- api/variables/LevelFormat.html | 2 +- api/variables/LevelSuffix.html | 2 +- api/variables/LineNumberRestartFormat.html | 2 +- api/variables/LineRuleType.html | 2 +- api/variables/NumberFormat.html | 2 +- api/variables/OverlapType.html | 2 +- api/variables/PageBorderDisplay.html | 2 +- api/variables/PageBorderOffsetFrom.html | 2 +- api/variables/PageBorderZOrder.html | 2 +- api/variables/PageNumber.html | 2 +- api/variables/PageNumberSeparator.html | 2 +- api/variables/PageOrientation.html | 2 +- api/variables/PageTextDirectionType.html | 2 +- api/variables/PatchType.html | 2 +- api/variables/PositionalTabAlignment.html | 2 +- api/variables/PositionalTabLeader.html | 2 +- api/variables/PositionalTabRelativeTo.html | 2 +- api/variables/PrettifyType.html | 2 +- api/variables/RelativeHorizontalPosition.html | 2 +- api/variables/RelativeVerticalPosition.html | 2 +- api/variables/SectionType.html | 2 +- api/variables/ShadingType.html | 2 +- api/variables/SpaceType.html | 2 +- api/variables/TabStopPosition.html | 2 +- api/variables/TabStopType.html | 2 +- api/variables/TableAnchorType.html | 2 +- api/variables/TableLayoutType.html | 2 +- api/variables/TextDirection.html | 2 +- api/variables/TextEffect.html | 2 +- api/variables/TextWrappingSide.html | 2 +- api/variables/TextWrappingType.html | 2 +- api/variables/UnderlineType.html | 2 +- api/variables/VerticalAlign.html | 2 +- api/variables/VerticalMergeType.html | 2 +- api/variables/VerticalPositionAlign.html | 2 +- .../VerticalPositionRelativeFrom.html | 2 +- api/variables/WidthType.html | 2 +- api/variables/sectionMarginDefaults.html | 2 +- api/variables/sectionPageSizeDefaults.html | 2 +- 367 files changed, 824 insertions(+), 824 deletions(-) diff --git a/api/classes/AbstractNumbering.html b/api/classes/AbstractNumbering.html index 6af075b08f..6b1d6f469b 100644 --- a/api/classes/AbstractNumbering.html +++ b/api/classes/AbstractNumbering.html @@ -1,6 +1,6 @@ -AbstractNumbering | docx

Class AbstractNumbering

Hierarchy

Constructors

constructor +AbstractNumbering | docx

Class AbstractNumbering

Hierarchy

Constructors

constructor

Properties

id

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonly id

id: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly id

id: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Alignment.html b/api/classes/Alignment.html index 3639673ca9..b81674b966 100644 --- a/api/classes/Alignment.html +++ b/api/classes/Alignment.html @@ -1,5 +1,5 @@ -Alignment | docx

Class Alignment

Hierarchy

Constructors

constructor +Alignment | docx

Class Alignment

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/AlignmentAttributes.html b/api/classes/AlignmentAttributes.html index f46e2a83b2..e9e874c622 100644 --- a/api/classes/AlignmentAttributes.html +++ b/api/classes/AlignmentAttributes.html @@ -1,3 +1,3 @@ -AlignmentAttributes | docx

Class AlignmentAttributes

Hierarchy

Constructors

constructor +AlignmentAttributes | docx

Class AlignmentAttributes

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/AnnotationReference.html b/api/classes/AnnotationReference.html index 0694e19c63..7354ed6adf 100644 --- a/api/classes/AnnotationReference.html +++ b/api/classes/AnnotationReference.html @@ -1,5 +1,5 @@ -AnnotationReference | docx

Class AnnotationReference

Hierarchy

Constructors

constructor +AnnotationReference | docx

Class AnnotationReference

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Attributes.html b/api/classes/Attributes.html index 226bdcafaa..4f05de067b 100644 --- a/api/classes/Attributes.html +++ b/api/classes/Attributes.html @@ -1,3 +1,3 @@ -Attributes | docx

Class Attributes

Hierarchy

  • 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

Constructors

constructor +Attributes | docx

Class Attributes

Hierarchy

  • 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

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new Attributes(root): Attributes

  • Parameters

    • root: {
          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;
      }
      • Optional Readonly bottom?: string
      • Optional Readonly color?: string
      • Optional Readonly fill?: string
      • Optional Readonly footer?: string
      • Optional Readonly gutter?: string
      • Optional Readonly h?: string
      • Optional Readonly header?: string
      • Optional Readonly left?: string
      • Optional Readonly linePitch?: string
      • Optional Readonly pos?: string | number
      • Optional Readonly right?: string
      • Optional Readonly rsidR?: string
      • Optional Readonly rsidRPr?: string
      • Optional Readonly rsidSect?: string
      • Optional Readonly space?: string
      • Optional Readonly sz?: string
      • Optional Readonly top?: string
      • Optional Readonly type?: string
      • Optional Readonly val?: string | number | boolean
      • Optional Readonly w?: string

    Returns Attributes

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

  • new Attributes(root): Attributes

  • Parameters

    • root: {
          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;
      }
      • Optional Readonly bottom?: string
      • Optional Readonly color?: string
      • Optional Readonly fill?: string
      • Optional Readonly footer?: string
      • Optional Readonly gutter?: string
      • Optional Readonly h?: string
      • Optional Readonly header?: string
      • Optional Readonly left?: string
      • Optional Readonly linePitch?: string
      • Optional Readonly pos?: string | number
      • Optional Readonly right?: string
      • Optional Readonly rsidR?: string
      • Optional Readonly rsidRPr?: string
      • Optional Readonly rsidSect?: string
      • Optional Readonly space?: string
      • Optional Readonly sz?: string
      • Optional Readonly top?: string
      • Optional Readonly type?: string
      • Optional Readonly val?: string | number | boolean
      • Optional Readonly w?: string

    Returns Attributes

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/BaseEmphasisMark.html b/api/classes/BaseEmphasisMark.html index bdd03959f2..e25945d802 100644 --- a/api/classes/BaseEmphasisMark.html +++ b/api/classes/BaseEmphasisMark.html @@ -1,4 +1,4 @@ -BaseEmphasisMark | docx

Class BaseEmphasisMarkAbstract

Hierarchy

Methods

addChildElement +BaseEmphasisMark | docx

Class BaseEmphasisMarkAbstract

Hierarchy

Methods

addChildElement prepForXml

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/BaseXmlComponent.html b/api/classes/BaseXmlComponent.html index c17c9a8b96..f9aa5b9fbf 100644 --- a/api/classes/BaseXmlComponent.html +++ b/api/classes/BaseXmlComponent.html @@ -1,3 +1,3 @@ -BaseXmlComponent | docx

Class BaseXmlComponentAbstract

Hierarchy

Constructors

constructor +BaseXmlComponent | docx

Class BaseXmlComponentAbstract

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

Abstract prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

Abstract prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Body.html b/api/classes/Body.html index b54b71b4a0..11f42bf16f 100644 --- a/api/classes/Body.html +++ b/api/classes/Body.html @@ -1,10 +1,10 @@ -Body | docx

Class Body

Hierarchy

Constructors

constructor +Body | docx

Class Body

Hierarchy

Constructors

constructor

Methods

addChildElement addSection prepForXml push -

Constructors

constructor

Methods

addChildElement

addSection

  • addSection(options): void

  • Adds new section properties. +

Constructors

constructor

Methods

addChildElement

addSection

  • addSection(options): void

  • Adds new section properties. Note: Previous section is created in paragraph after the current element, and then new section will be added. The spec says:

      @@ -12,4 +12,4 @@ The spec says:

    • last section should be direct child of body

    Parameters

    Returns void

prepForXml

push

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns void

prepForXml

push

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Bookmark.html b/api/classes/Bookmark.html index 92878f7184..f10a88a362 100644 --- a/api/classes/Bookmark.html +++ b/api/classes/Bookmark.html @@ -1,5 +1,5 @@ -Bookmark | docx

Class Bookmark

Constructors

constructor +Bookmark | docx

Class Bookmark

Constructors

constructor

Properties

children end start -

Constructors

constructor

Properties

Readonly children

children: readonly ParagraphChild[]

Readonly end

end: BookmarkEnd

Readonly start

start: BookmarkStart

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly children

children: readonly ParagraphChild[]

Readonly end

end: BookmarkEnd

Readonly start

start: BookmarkStart

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/BookmarkEnd.html b/api/classes/BookmarkEnd.html index f51272cce2..772ef7c4e6 100644 --- a/api/classes/BookmarkEnd.html +++ b/api/classes/BookmarkEnd.html @@ -1,5 +1,5 @@ -BookmarkEnd | docx

Class BookmarkEnd

Hierarchy

Constructors

constructor +BookmarkEnd | docx

Class BookmarkEnd

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/BookmarkStart.html b/api/classes/BookmarkStart.html index 6db5469dc0..c1c7e826a2 100644 --- a/api/classes/BookmarkStart.html +++ b/api/classes/BookmarkStart.html @@ -1,5 +1,5 @@ -BookmarkStart | docx

Class BookmarkStart

Hierarchy

Constructors

constructor +BookmarkStart | docx

Class BookmarkStart

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Border.html b/api/classes/Border.html index 32d7d48730..4eb0bc2130 100644 --- a/api/classes/Border.html +++ b/api/classes/Border.html @@ -1,5 +1,5 @@ -Border | docx

Class Border

Hierarchy

Constructors

constructor +Border | docx

Class Border

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/BorderElement.html b/api/classes/BorderElement.html index 917d8c916c..aed384f82e 100644 --- a/api/classes/BorderElement.html +++ b/api/classes/BorderElement.html @@ -1,5 +1,5 @@ -BorderElement | docx

Class BorderElement

Hierarchy

Constructors

constructor +BorderElement | docx

Class BorderElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/BuilderElement.html b/api/classes/BuilderElement.html index a80b057f49..e7088ed9c7 100644 --- a/api/classes/BuilderElement.html +++ b/api/classes/BuilderElement.html @@ -1,5 +1,5 @@ -BuilderElement | docx

Class BuilderElement<T>

Type Parameters

Hierarchy

Constructors

constructor +BuilderElement | docx

Class BuilderElement<T>

Type Parameters

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/CarriageReturn.html b/api/classes/CarriageReturn.html index 6a62c558a3..d260ef0d28 100644 --- a/api/classes/CarriageReturn.html +++ b/api/classes/CarriageReturn.html @@ -1,5 +1,5 @@ -CarriageReturn | docx

Class CarriageReturn

Hierarchy

Constructors

constructor +CarriageReturn | docx

Class CarriageReturn

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/CheckBox.html b/api/classes/CheckBox.html index d6f532473d..5a672fac16 100644 --- a/api/classes/CheckBox.html +++ b/api/classes/CheckBox.html @@ -1,5 +1,5 @@ -CheckBox | docx

Class CheckBox

Hierarchy

Constructors

constructor +CheckBox | docx

Class CheckBox

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/CheckBoxSymbolElement.html b/api/classes/CheckBoxSymbolElement.html index 4272d6adac..847e9facab 100644 --- a/api/classes/CheckBoxSymbolElement.html +++ b/api/classes/CheckBoxSymbolElement.html @@ -1,5 +1,5 @@ -CheckBoxSymbolElement | docx

Class CheckBoxSymbolElement

Hierarchy

Constructors

constructor +CheckBoxSymbolElement | docx

Class CheckBoxSymbolElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/CheckBoxUtil.html b/api/classes/CheckBoxUtil.html index 26f8cafec3..1d0c19b719 100644 --- a/api/classes/CheckBoxUtil.html +++ b/api/classes/CheckBoxUtil.html @@ -1,5 +1,5 @@ -CheckBoxUtil | docx

Class CheckBoxUtil

Hierarchy

Constructors

constructor +CheckBoxUtil | docx

Class CheckBoxUtil

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Column.html b/api/classes/Column.html index 325176493e..88afce963e 100644 --- a/api/classes/Column.html +++ b/api/classes/Column.html @@ -1,5 +1,5 @@ -Column | docx

Class Column

Hierarchy

Constructors

constructor +Column | docx

Class Column

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/ColumnBreak.html b/api/classes/ColumnBreak.html index 222819b752..0ac3927dee 100644 --- a/api/classes/ColumnBreak.html +++ b/api/classes/ColumnBreak.html @@ -1,5 +1,5 @@ -ColumnBreak | docx

Class ColumnBreak

Hierarchy

Constructors

constructor +ColumnBreak | docx

Class ColumnBreak

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Columns.html b/api/classes/Columns.html index c1615ab2fe..93f6bee35f 100644 --- a/api/classes/Columns.html +++ b/api/classes/Columns.html @@ -1,5 +1,5 @@ -Columns | docx

Class Columns

Hierarchy

Constructors

constructor +Columns | docx

Class Columns

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Comment.html b/api/classes/Comment.html index 4ac82c39d1..9f7b526821 100644 --- a/api/classes/Comment.html +++ b/api/classes/Comment.html @@ -1,5 +1,5 @@ -Comment | docx

Class Comment

Hierarchy

Constructors

constructor +Comment | docx

Class Comment

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/CommentRangeEnd.html b/api/classes/CommentRangeEnd.html index b76d6859bf..d47e7e343f 100644 --- a/api/classes/CommentRangeEnd.html +++ b/api/classes/CommentRangeEnd.html @@ -1,5 +1,5 @@ -CommentRangeEnd | docx

Class CommentRangeEnd

Hierarchy

Constructors

constructor +CommentRangeEnd | docx

Class CommentRangeEnd

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/CommentRangeStart.html b/api/classes/CommentRangeStart.html index df7422ec40..daf534fb3f 100644 --- a/api/classes/CommentRangeStart.html +++ b/api/classes/CommentRangeStart.html @@ -1,5 +1,5 @@ -CommentRangeStart | docx

Class CommentRangeStart

Hierarchy

Constructors

constructor +CommentRangeStart | docx

Class CommentRangeStart

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/CommentReference.html b/api/classes/CommentReference.html index 403f0d4c09..5b72d1c99d 100644 --- a/api/classes/CommentReference.html +++ b/api/classes/CommentReference.html @@ -1,5 +1,5 @@ -CommentReference | docx

Class CommentReference

Hierarchy

Constructors

constructor +CommentReference | docx

Class CommentReference

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Comments.html b/api/classes/Comments.html index 86e5e75b6f..555d040cb2 100644 --- a/api/classes/Comments.html +++ b/api/classes/Comments.html @@ -1,5 +1,5 @@ -Comments | docx

Class Comments

Hierarchy

Constructors

constructor +Comments | docx

Class Comments

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/ConcreteHyperlink.html b/api/classes/ConcreteHyperlink.html index 4760b74712..550cd7a2d2 100644 --- a/api/classes/ConcreteHyperlink.html +++ b/api/classes/ConcreteHyperlink.html @@ -1,6 +1,6 @@ -ConcreteHyperlink | docx

Class ConcreteHyperlink

Hierarchy

Constructors

constructor +ConcreteHyperlink | docx

Class ConcreteHyperlink

Hierarchy

Constructors

constructor

Properties

linkId

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonly linkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly linkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/ConcreteNumbering.html b/api/classes/ConcreteNumbering.html index b2e10e5e89..9519565d01 100644 --- a/api/classes/ConcreteNumbering.html +++ b/api/classes/ConcreteNumbering.html @@ -1,8 +1,8 @@ -ConcreteNumbering | docx

Class ConcreteNumbering

Hierarchy

Constructors

constructor +ConcreteNumbering | docx

Class ConcreteNumbering

Hierarchy

Constructors

constructor

Properties

instance numId reference

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonly instance

instance: number

Readonly numId

numId: number

Readonly reference

reference: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly instance

instance: number

Readonly numId

numId: number

Readonly reference

reference: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/ContinuationSeparator.html b/api/classes/ContinuationSeparator.html index dd6c7cfbda..4fc0b9a3ea 100644 --- a/api/classes/ContinuationSeparator.html +++ b/api/classes/ContinuationSeparator.html @@ -1,5 +1,5 @@ -ContinuationSeparator | docx

Class ContinuationSeparator

Hierarchy

Constructors

constructor +ContinuationSeparator | docx

Class ContinuationSeparator

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/DayLong.html b/api/classes/DayLong.html index 6ad3421552..ea7d14f378 100644 --- a/api/classes/DayLong.html +++ b/api/classes/DayLong.html @@ -1,5 +1,5 @@ -DayLong | docx

Class DayLong

Hierarchy

Constructors

constructor +DayLong | docx

Class DayLong

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/DayShort.html b/api/classes/DayShort.html index 2fabafeb81..ff384c80f0 100644 --- a/api/classes/DayShort.html +++ b/api/classes/DayShort.html @@ -1,5 +1,5 @@ -DayShort | docx

Class DayShort

Hierarchy

Constructors

constructor +DayShort | docx

Class DayShort

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/DeletedTextRun.html b/api/classes/DeletedTextRun.html index 3af7ee4add..6682af17bf 100644 --- a/api/classes/DeletedTextRun.html +++ b/api/classes/DeletedTextRun.html @@ -1,5 +1,5 @@ -DeletedTextRun | docx

Class DeletedTextRun

Hierarchy

Constructors

constructor +DeletedTextRun | docx

Class DeletedTextRun

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/DocGridAttributes.html b/api/classes/DocGridAttributes.html index b51b5ce179..f4ba474e96 100644 --- a/api/classes/DocGridAttributes.html +++ b/api/classes/DocGridAttributes.html @@ -1,3 +1,3 @@ -DocGridAttributes | docx

Class DocGridAttributes

Hierarchy

Constructors

constructor +DocGridAttributes | docx

Class DocGridAttributes

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Document.html b/api/classes/Document.html index 9c2436be6d..52e769caca 100644 --- a/api/classes/Document.html +++ b/api/classes/Document.html @@ -1,4 +1,4 @@ -Document | docx

Class Document

Constructors

constructor +Document | docx

Class Document

Constructors

constructor

Accessors

AppProperties Comments ContentTypes @@ -13,4 +13,4 @@ Numbering Settings Styles -

Constructors

constructor

Accessors

AppProperties

  • get AppProperties(): AppProperties

  • Returns AppProperties

Comments

ContentTypes

CoreProperties

  • get CoreProperties(): CoreProperties

  • Returns CoreProperties

CustomProperties

  • get CustomProperties(): CustomProperties

  • Returns CustomProperties

Document

  • get Document(): DocumentWrapper

  • Returns DocumentWrapper

FileRelationships

  • get FileRelationships(): Relationships

  • Returns Relationships

FootNotes

  • get FootNotes(): FootnotesWrapper

  • Returns FootnotesWrapper

Footers

Headers

Media

Numbering

Settings

Styles

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Accessors

AppProperties

  • get AppProperties(): AppProperties

  • Returns AppProperties

Comments

ContentTypes

CoreProperties

  • get CoreProperties(): CoreProperties

  • Returns CoreProperties

CustomProperties

  • get CustomProperties(): CustomProperties

  • Returns CustomProperties

Document

  • get Document(): DocumentWrapper

  • Returns DocumentWrapper

FileRelationships

  • get FileRelationships(): Relationships

  • Returns Relationships

FootNotes

  • get FootNotes(): FootnotesWrapper

  • Returns FootnotesWrapper

Footers

Headers

Media

Numbering

Settings

Styles

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/DocumentAttributes.html b/api/classes/DocumentAttributes.html index 6cd6dbce68..a77557877f 100644 --- a/api/classes/DocumentAttributes.html +++ b/api/classes/DocumentAttributes.html @@ -1,3 +1,3 @@ -DocumentAttributes | docx

Class DocumentAttributes

Hierarchy

Constructors

constructor +DocumentAttributes | docx

Class DocumentAttributes

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/DocumentBackground.html b/api/classes/DocumentBackground.html index 820fb9b133..d616cc78c8 100644 --- a/api/classes/DocumentBackground.html +++ b/api/classes/DocumentBackground.html @@ -1,5 +1,5 @@ -DocumentBackground | docx

Class DocumentBackground

Hierarchy

Constructors

constructor +DocumentBackground | docx

Class DocumentBackground

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/DocumentBackgroundAttributes.html b/api/classes/DocumentBackgroundAttributes.html index 2bddc2ece6..89579ffcab 100644 --- a/api/classes/DocumentBackgroundAttributes.html +++ b/api/classes/DocumentBackgroundAttributes.html @@ -1,3 +1,3 @@ -DocumentBackgroundAttributes | docx

Class DocumentBackgroundAttributes

Hierarchy

  • XmlAttributeComponent<{
        color?: string;
        themeColor?: string;
        themeShade?: string;
        themeTint?: string;
    }>
    • DocumentBackgroundAttributes

Constructors

constructor +DocumentBackgroundAttributes | docx

Class DocumentBackgroundAttributes

Hierarchy

  • XmlAttributeComponent<{
        color?: string;
        themeColor?: string;
        themeShade?: string;
        themeTint?: string;
    }>
    • DocumentBackgroundAttributes

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/DocumentDefaults.html b/api/classes/DocumentDefaults.html index 5d1b01d426..0f99d3120b 100644 --- a/api/classes/DocumentDefaults.html +++ b/api/classes/DocumentDefaults.html @@ -1,5 +1,5 @@ -DocumentDefaults | docx

Class DocumentDefaults

Hierarchy

Constructors

constructor +DocumentDefaults | docx

Class DocumentDefaults

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/DocumentGrid.html b/api/classes/DocumentGrid.html index da9a32ce8b..b7187686db 100644 --- a/api/classes/DocumentGrid.html +++ b/api/classes/DocumentGrid.html @@ -1,5 +1,5 @@ -DocumentGrid | docx

Class DocumentGrid

Hierarchy

Constructors

constructor +DocumentGrid | docx

Class DocumentGrid

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/DotEmphasisMark.html b/api/classes/DotEmphasisMark.html index 4508da9817..5009870bf5 100644 --- a/api/classes/DotEmphasisMark.html +++ b/api/classes/DotEmphasisMark.html @@ -1,5 +1,5 @@ -DotEmphasisMark | docx

Class DotEmphasisMark

Hierarchy

Constructors

constructor +DotEmphasisMark | docx

Class DotEmphasisMark

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Drawing.html b/api/classes/Drawing.html index 081f5c9ddd..57c75eabfb 100644 --- a/api/classes/Drawing.html +++ b/api/classes/Drawing.html @@ -1,5 +1,5 @@ -Drawing | docx

Class Drawing

Hierarchy

Constructors

constructor +Drawing | docx

Class Drawing

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/EmphasisMark.html b/api/classes/EmphasisMark.html index 8bab3551a9..2c5e98f96e 100644 --- a/api/classes/EmphasisMark.html +++ b/api/classes/EmphasisMark.html @@ -1,5 +1,5 @@ -EmphasisMark | docx

Class EmphasisMark

Hierarchy

Constructors

constructor +EmphasisMark | docx

Class EmphasisMark

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/EmptyElement.html b/api/classes/EmptyElement.html index 0148689ba1..0856c07baf 100644 --- a/api/classes/EmptyElement.html +++ b/api/classes/EmptyElement.html @@ -1,5 +1,5 @@ -EmptyElement | docx

Class EmptyElement

Hierarchy

Constructors

constructor +EmptyElement | docx

Class EmptyElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/EndnoteReference.html b/api/classes/EndnoteReference.html index 8eac10499e..6e3996d62d 100644 --- a/api/classes/EndnoteReference.html +++ b/api/classes/EndnoteReference.html @@ -1,5 +1,5 @@ -EndnoteReference | docx

Class EndnoteReference

Hierarchy

Constructors

constructor +EndnoteReference | docx

Class EndnoteReference

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/ExternalHyperlink.html b/api/classes/ExternalHyperlink.html index 3da735ab75..a50e35c7c5 100644 --- a/api/classes/ExternalHyperlink.html +++ b/api/classes/ExternalHyperlink.html @@ -1,6 +1,6 @@ -ExternalHyperlink | docx

Class ExternalHyperlink

Hierarchy

Constructors

constructor +ExternalHyperlink | docx

Class ExternalHyperlink

Hierarchy

Constructors

constructor

Properties

options

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonly options

options: {
    children: readonly ParagraphChild[];
    link: string;
}

Type declaration

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly options

options: {
    children: readonly ParagraphChild[];
    link: string;
}

Type declaration

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/FootNoteReferenceRunAttributes.html b/api/classes/FootNoteReferenceRunAttributes.html index 5555c2d037..d42e2e2fae 100644 --- a/api/classes/FootNoteReferenceRunAttributes.html +++ b/api/classes/FootNoteReferenceRunAttributes.html @@ -1,3 +1,3 @@ -FootNoteReferenceRunAttributes | docx

Class FootNoteReferenceRunAttributes

Hierarchy

Constructors

constructor +FootNoteReferenceRunAttributes | docx

Class FootNoteReferenceRunAttributes

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/FootNotes.html b/api/classes/FootNotes.html index 4a57cf2275..e497c56fcd 100644 --- a/api/classes/FootNotes.html +++ b/api/classes/FootNotes.html @@ -1,6 +1,6 @@ -FootNotes | docx

Class FootNotes

Hierarchy

Constructors

constructor +FootNotes | docx

Class FootNotes

Hierarchy

Constructors

constructor

Methods

addChildElement createFootNote prepForXml -

Constructors

constructor

Methods

addChildElement

createFootNote

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

createFootNote

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Footer.html b/api/classes/Footer.html index aa3bd78026..5ed41d7b2a 100644 --- a/api/classes/Footer.html +++ b/api/classes/Footer.html @@ -1,3 +1,3 @@ -Footer | docx

Class Footer

Constructors

constructor +Footer | docx

Class Footer

Constructors

constructor

Properties

options -

Constructors

constructor

Properties

Readonly options

options: IHeaderOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly options

options: IHeaderOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/FooterWrapper.html b/api/classes/FooterWrapper.html index 2c453bcb82..d918dfc0c4 100644 --- a/api/classes/FooterWrapper.html +++ b/api/classes/FooterWrapper.html @@ -1,7 +1,7 @@ -FooterWrapper | docx

Class FooterWrapper

Implements

  • IViewWrapper

Constructors

constructor +FooterWrapper | docx

Class FooterWrapper

Implements

  • IViewWrapper

Constructors

constructor

Accessors

Media Relationships View

Methods

add addChildElement -

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/FootnoteReference.html b/api/classes/FootnoteReference.html index a0f2ea318d..fb1461b2a8 100644 --- a/api/classes/FootnoteReference.html +++ b/api/classes/FootnoteReference.html @@ -1,5 +1,5 @@ -FootnoteReference | docx

Class FootnoteReference

Hierarchy

Constructors

constructor +FootnoteReference | docx

Class FootnoteReference

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/FootnoteReferenceElement.html b/api/classes/FootnoteReferenceElement.html index b4bfbf6681..d931ba59ac 100644 --- a/api/classes/FootnoteReferenceElement.html +++ b/api/classes/FootnoteReferenceElement.html @@ -1,5 +1,5 @@ -FootnoteReferenceElement | docx

Class FootnoteReferenceElement

Hierarchy

Constructors

constructor +FootnoteReferenceElement | docx

Class FootnoteReferenceElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/FootnoteReferenceRun.html b/api/classes/FootnoteReferenceRun.html index 9bb2fdb815..f2d5737bec 100644 --- a/api/classes/FootnoteReferenceRun.html +++ b/api/classes/FootnoteReferenceRun.html @@ -1,5 +1,5 @@ -FootnoteReferenceRun | docx

Class FootnoteReferenceRun

Hierarchy

  • Run
    • FootnoteReferenceRun

Constructors

constructor +FootnoteReferenceRun | docx

Class FootnoteReferenceRun

Hierarchy

  • Run
    • FootnoteReferenceRun

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/FrameProperties.html b/api/classes/FrameProperties.html index 484553cb45..ac14fa4a73 100644 --- a/api/classes/FrameProperties.html +++ b/api/classes/FrameProperties.html @@ -1,5 +1,5 @@ -FrameProperties | docx

Class FrameProperties

Hierarchy

Constructors

constructor +FrameProperties | docx

Class FrameProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/FramePropertiesAttributes.html b/api/classes/FramePropertiesAttributes.html index 948eaa085a..3e184d341e 100644 --- a/api/classes/FramePropertiesAttributes.html +++ b/api/classes/FramePropertiesAttributes.html @@ -1,3 +1,3 @@ -FramePropertiesAttributes | docx

Class FramePropertiesAttributes

Hierarchy

Constructors

constructor +FramePropertiesAttributes | docx

Class FramePropertiesAttributes

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new FramePropertiesAttributes(root): FramePropertiesAttributes

  • Parameters

    • root: {
          alignmentX?: "center" | "left" | "right" | "inside" | "outside";
          alignmentY?: "bottom" | "center" | "top" | "inside" | "outside";
          anchorHorizontal?: "text" | "margin" | "page";
          anchorLock?: boolean;
          anchorVertical?: "text" | "margin" | "page";
          dropCap?: "none" | "margin" | "drop";
          height: number;
          lines?: number;
          rule?: "auto" | "atLeast" | "exact";
          spaceHorizontal?: number;
          spaceVertical?: number;
          width: number;
          wrap?: "auto" | "none" | "around" | "notBeside" | "through" | "tight";
          x?: number;
          y?: number;
      }
      • Optional Readonly alignmentX?: "center" | "left" | "right" | "inside" | "outside"
      • Optional Readonly alignmentY?: "bottom" | "center" | "top" | "inside" | "outside"
      • Optional Readonly anchorHorizontal?: "text" | "margin" | "page"
      • Optional Readonly anchorLock?: boolean
      • Optional Readonly anchorVertical?: "text" | "margin" | "page"
      • Optional Readonly dropCap?: "none" | "margin" | "drop"
      • Readonly height: number
      • Optional Readonly lines?: number
      • Optional Readonly rule?: "auto" | "atLeast" | "exact"
      • Optional Readonly spaceHorizontal?: number
      • Optional Readonly spaceVertical?: number
      • Readonly width: number
      • Optional Readonly wrap?: "auto" | "none" | "around" | "notBeside" | "through" | "tight"
      • Optional Readonly x?: number
      • Optional Readonly y?: number

    Returns FramePropertiesAttributes

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

  • new FramePropertiesAttributes(root): FramePropertiesAttributes

  • Parameters

    • root: {
          alignmentX?: "center" | "left" | "right" | "inside" | "outside";
          alignmentY?: "bottom" | "center" | "top" | "inside" | "outside";
          anchorHorizontal?: "text" | "margin" | "page";
          anchorLock?: boolean;
          anchorVertical?: "text" | "margin" | "page";
          dropCap?: "none" | "margin" | "drop";
          height: number;
          lines?: number;
          rule?: "auto" | "atLeast" | "exact";
          spaceHorizontal?: number;
          spaceVertical?: number;
          width: number;
          wrap?: "auto" | "none" | "around" | "notBeside" | "through" | "tight";
          x?: number;
          y?: number;
      }
      • Optional Readonly alignmentX?: "center" | "left" | "right" | "inside" | "outside"
      • Optional Readonly alignmentY?: "bottom" | "center" | "top" | "inside" | "outside"
      • Optional Readonly anchorHorizontal?: "text" | "margin" | "page"
      • Optional Readonly anchorLock?: boolean
      • Optional Readonly anchorVertical?: "text" | "margin" | "page"
      • Optional Readonly dropCap?: "none" | "margin" | "drop"
      • Readonly height: number
      • Optional Readonly lines?: number
      • Optional Readonly rule?: "auto" | "atLeast" | "exact"
      • Optional Readonly spaceHorizontal?: number
      • Optional Readonly spaceVertical?: number
      • Readonly width: number
      • Optional Readonly wrap?: "auto" | "none" | "around" | "notBeside" | "through" | "tight"
      • Optional Readonly x?: number
      • Optional Readonly y?: number

    Returns FramePropertiesAttributes

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/GridSpan.html b/api/classes/GridSpan.html index ecafd47c83..ce8d66b7af 100644 --- a/api/classes/GridSpan.html +++ b/api/classes/GridSpan.html @@ -1,6 +1,6 @@ GridSpan | docx

Class GridSpan

GridSpan element. Should be used in a table cell. Pass the number of columns that this cell need to span.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Header.html b/api/classes/Header.html index 21b0d51c0d..1f25ec7b28 100644 --- a/api/classes/Header.html +++ b/api/classes/Header.html @@ -1,3 +1,3 @@ -Header | docx

Class Header

Constructors

constructor +Header | docx

Class Header

Constructors

constructor

Properties

options -

Constructors

constructor

Properties

Readonly options

options: IHeaderOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly options

options: IHeaderOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/HeaderFooterReference.html b/api/classes/HeaderFooterReference.html index 8f4030d31f..40630cb940 100644 --- a/api/classes/HeaderFooterReference.html +++ b/api/classes/HeaderFooterReference.html @@ -1,5 +1,5 @@ -HeaderFooterReference | docx

Class HeaderFooterReference

Hierarchy

Constructors

constructor +HeaderFooterReference | docx

Class HeaderFooterReference

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/HeaderWrapper.html b/api/classes/HeaderWrapper.html index 0f80872b78..ed20cbee3e 100644 --- a/api/classes/HeaderWrapper.html +++ b/api/classes/HeaderWrapper.html @@ -1,7 +1,7 @@ -HeaderWrapper | docx

Class HeaderWrapper

Implements

  • IViewWrapper

Constructors

constructor +HeaderWrapper | docx

Class HeaderWrapper

Implements

  • IViewWrapper

Constructors

constructor

Accessors

Media Relationships View

Methods

add addChildElement -

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/HorizontalPosition.html b/api/classes/HorizontalPosition.html index 170af95a4f..3e761956ac 100644 --- a/api/classes/HorizontalPosition.html +++ b/api/classes/HorizontalPosition.html @@ -1,5 +1,5 @@ -HorizontalPosition | docx

Class HorizontalPosition

Hierarchy

Constructors

constructor +HorizontalPosition | docx

Class HorizontalPosition

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/HpsMeasureElement.html b/api/classes/HpsMeasureElement.html index 2eb7a3bc80..06fed7db10 100644 --- a/api/classes/HpsMeasureElement.html +++ b/api/classes/HpsMeasureElement.html @@ -1,5 +1,5 @@ -HpsMeasureElement | docx

Class HpsMeasureElement

Hierarchy

Constructors

constructor +HpsMeasureElement | docx

Class HpsMeasureElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/IgnoreIfEmptyXmlComponent.html b/api/classes/IgnoreIfEmptyXmlComponent.html index 9a5f4d9277..18448ee5ac 100644 --- a/api/classes/IgnoreIfEmptyXmlComponent.html +++ b/api/classes/IgnoreIfEmptyXmlComponent.html @@ -1,5 +1,5 @@ -IgnoreIfEmptyXmlComponent | docx

Class IgnoreIfEmptyXmlComponentAbstract

Hierarchy

Constructors

constructor +IgnoreIfEmptyXmlComponent | docx

Class IgnoreIfEmptyXmlComponentAbstract

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/ImageRun.html b/api/classes/ImageRun.html index 2c292d4ef0..daf3ec9db2 100644 --- a/api/classes/ImageRun.html +++ b/api/classes/ImageRun.html @@ -1,5 +1,5 @@ -ImageRun | docx

Class ImageRun

Hierarchy

Constructors

constructor +ImageRun | docx

Class ImageRun

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/ImportedRootElementAttributes.html b/api/classes/ImportedRootElementAttributes.html index c60b248c22..d4f2cd14a6 100644 --- a/api/classes/ImportedRootElementAttributes.html +++ b/api/classes/ImportedRootElementAttributes.html @@ -1,6 +1,6 @@ ImportedRootElementAttributes | docx

Class ImportedRootElementAttributes

Used for the attributes of root element that is being imported.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/ImportedXmlComponent.html b/api/classes/ImportedXmlComponent.html index bbd0614b0c..aa99d61a32 100644 --- a/api/classes/ImportedXmlComponent.html +++ b/api/classes/ImportedXmlComponent.html @@ -1,11 +1,11 @@ ImportedXmlComponent | docx

Class ImportedXmlComponent

Represents imported xml component from xml file.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml push fromXmlString

Constructors

constructor

Methods

addChildElement

prepForXml

push

Static fromXmlString

Methods

addChildElement

prepForXml

push

Static fromXmlString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns ImportedXmlComponent

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Indent.html b/api/classes/Indent.html index 757cec71ed..e377185260 100644 --- a/api/classes/Indent.html +++ b/api/classes/Indent.html @@ -1,5 +1,5 @@ -Indent | docx

Class Indent

Hierarchy

Constructors

constructor +Indent | docx

Class Indent

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/InitializableXmlComponent.html b/api/classes/InitializableXmlComponent.html index 9919665c67..e31910df49 100644 --- a/api/classes/InitializableXmlComponent.html +++ b/api/classes/InitializableXmlComponent.html @@ -1,5 +1,5 @@ -InitializableXmlComponent | docx

Class InitializableXmlComponentAbstract

Hierarchy

Constructors

constructor +InitializableXmlComponent | docx

Class InitializableXmlComponentAbstract

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/InsertedTextRun.html b/api/classes/InsertedTextRun.html index 3a603a8130..8c6b20df72 100644 --- a/api/classes/InsertedTextRun.html +++ b/api/classes/InsertedTextRun.html @@ -1,5 +1,5 @@ -InsertedTextRun | docx

Class InsertedTextRun

Hierarchy

Constructors

constructor +InsertedTextRun | docx

Class InsertedTextRun

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/InternalHyperlink.html b/api/classes/InternalHyperlink.html index 7e49aca456..38bb83b104 100644 --- a/api/classes/InternalHyperlink.html +++ b/api/classes/InternalHyperlink.html @@ -1,6 +1,6 @@ -InternalHyperlink | docx

Class InternalHyperlink

Hierarchy

Constructors

constructor +InternalHyperlink | docx

Class InternalHyperlink

Hierarchy

Constructors

constructor

Properties

linkId

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonly linkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly linkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/LastRenderedPageBreak.html b/api/classes/LastRenderedPageBreak.html index ca5d0f5bee..2a28125955 100644 --- a/api/classes/LastRenderedPageBreak.html +++ b/api/classes/LastRenderedPageBreak.html @@ -1,5 +1,5 @@ -LastRenderedPageBreak | docx

Class LastRenderedPageBreak

Hierarchy

Constructors

constructor +LastRenderedPageBreak | docx

Class LastRenderedPageBreak

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Level.html b/api/classes/Level.html index 16a6b8c542..8f7a979bc6 100644 --- a/api/classes/Level.html +++ b/api/classes/Level.html @@ -1,5 +1,5 @@ -Level | docx

Class Level

Hierarchy

Constructors

constructor +Level | docx

Class Level

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/LevelBase.html b/api/classes/LevelBase.html index 2eccaa871e..3b96a24100 100644 --- a/api/classes/LevelBase.html +++ b/api/classes/LevelBase.html @@ -1,5 +1,5 @@ -LevelBase | docx

Class LevelBase

Hierarchy

Constructors

constructor +LevelBase | docx

Class LevelBase

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/LevelForOverride.html b/api/classes/LevelForOverride.html index 172f26779a..ea1a4e4a0d 100644 --- a/api/classes/LevelForOverride.html +++ b/api/classes/LevelForOverride.html @@ -1,5 +1,5 @@ -LevelForOverride | docx

Class LevelForOverride

Hierarchy

Constructors

constructor +LevelForOverride | docx

Class LevelForOverride

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/LevelOverride.html b/api/classes/LevelOverride.html index 3668ee6cea..ca5f1b67ea 100644 --- a/api/classes/LevelOverride.html +++ b/api/classes/LevelOverride.html @@ -1,5 +1,5 @@ -LevelOverride | docx

Class LevelOverride

Hierarchy

Constructors

constructor +LevelOverride | docx

Class LevelOverride

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Math.html b/api/classes/Math.html index 347f9a5a56..2165890413 100644 --- a/api/classes/Math.html +++ b/api/classes/Math.html @@ -1,5 +1,5 @@ -Math | docx

Class Math

Hierarchy

Constructors

constructor +Math | docx

Class Math

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathAccentCharacter.html b/api/classes/MathAccentCharacter.html index e364ed5dea..d5273e2271 100644 --- a/api/classes/MathAccentCharacter.html +++ b/api/classes/MathAccentCharacter.html @@ -1,5 +1,5 @@ -MathAccentCharacter | docx

Class MathAccentCharacter

Hierarchy

Constructors

constructor +MathAccentCharacter | docx

Class MathAccentCharacter

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathAngledBrackets.html b/api/classes/MathAngledBrackets.html index 1195d697c9..33d035eb4e 100644 --- a/api/classes/MathAngledBrackets.html +++ b/api/classes/MathAngledBrackets.html @@ -1,5 +1,5 @@ -MathAngledBrackets | docx

Class MathAngledBrackets

Hierarchy

Constructors

constructor +MathAngledBrackets | docx

Class MathAngledBrackets

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathBase.html b/api/classes/MathBase.html index d9fba3124c..fd7dd5ac3a 100644 --- a/api/classes/MathBase.html +++ b/api/classes/MathBase.html @@ -1,5 +1,5 @@ -MathBase | docx

Class MathBase

Hierarchy

Constructors

constructor +MathBase | docx

Class MathBase

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathCurlyBrackets.html b/api/classes/MathCurlyBrackets.html index 2af8952377..9363dbdf69 100644 --- a/api/classes/MathCurlyBrackets.html +++ b/api/classes/MathCurlyBrackets.html @@ -1,5 +1,5 @@ -MathCurlyBrackets | docx

Class MathCurlyBrackets

Hierarchy

Constructors

constructor +MathCurlyBrackets | docx

Class MathCurlyBrackets

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathDegree.html b/api/classes/MathDegree.html index f42a77baef..2698a29f50 100644 --- a/api/classes/MathDegree.html +++ b/api/classes/MathDegree.html @@ -1,5 +1,5 @@ -MathDegree | docx

Class MathDegree

Hierarchy

Constructors

constructor +MathDegree | docx

Class MathDegree

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathDenominator.html b/api/classes/MathDenominator.html index 24ac9014d9..8a1171bcd0 100644 --- a/api/classes/MathDenominator.html +++ b/api/classes/MathDenominator.html @@ -1,5 +1,5 @@ -MathDenominator | docx

Class MathDenominator

Hierarchy

Constructors

constructor +MathDenominator | docx

Class MathDenominator

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathFraction.html b/api/classes/MathFraction.html index 80f3aa5ae8..683b39e612 100644 --- a/api/classes/MathFraction.html +++ b/api/classes/MathFraction.html @@ -1,5 +1,5 @@ -MathFraction | docx

Class MathFraction

Hierarchy

Constructors

constructor +MathFraction | docx

Class MathFraction

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathFunction.html b/api/classes/MathFunction.html index 464eea5e56..a25ebe2860 100644 --- a/api/classes/MathFunction.html +++ b/api/classes/MathFunction.html @@ -1,5 +1,5 @@ -MathFunction | docx

Class MathFunction

Hierarchy

Constructors

constructor +MathFunction | docx

Class MathFunction

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathFunctionName.html b/api/classes/MathFunctionName.html index f1626e1aa8..0c10bf0e7f 100644 --- a/api/classes/MathFunctionName.html +++ b/api/classes/MathFunctionName.html @@ -1,5 +1,5 @@ -MathFunctionName | docx

Class MathFunctionName

Hierarchy

Constructors

constructor +MathFunctionName | docx

Class MathFunctionName

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathFunctionProperties.html b/api/classes/MathFunctionProperties.html index 39eb77ace7..f08775f085 100644 --- a/api/classes/MathFunctionProperties.html +++ b/api/classes/MathFunctionProperties.html @@ -1,5 +1,5 @@ -MathFunctionProperties | docx

Class MathFunctionProperties

Hierarchy

Constructors

constructor +MathFunctionProperties | docx

Class MathFunctionProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathIntegral.html b/api/classes/MathIntegral.html index e531f26385..f8ac2fc731 100644 --- a/api/classes/MathIntegral.html +++ b/api/classes/MathIntegral.html @@ -1,5 +1,5 @@ -MathIntegral | docx

Class MathIntegral

Hierarchy

Constructors

constructor +MathIntegral | docx

Class MathIntegral

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathLimitLocation.html b/api/classes/MathLimitLocation.html index 733b23a936..711d8e6e5c 100644 --- a/api/classes/MathLimitLocation.html +++ b/api/classes/MathLimitLocation.html @@ -1,5 +1,5 @@ -MathLimitLocation | docx

Class MathLimitLocation

Hierarchy

Constructors

constructor +MathLimitLocation | docx

Class MathLimitLocation

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathNAryProperties.html b/api/classes/MathNAryProperties.html index 23b4ddccfd..97e9ef03ce 100644 --- a/api/classes/MathNAryProperties.html +++ b/api/classes/MathNAryProperties.html @@ -1,5 +1,5 @@ -MathNAryProperties | docx

Class MathNAryProperties

Hierarchy

Constructors

constructor +MathNAryProperties | docx

Class MathNAryProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathNumerator.html b/api/classes/MathNumerator.html index 56873a092c..bd97a4a08f 100644 --- a/api/classes/MathNumerator.html +++ b/api/classes/MathNumerator.html @@ -1,5 +1,5 @@ -MathNumerator | docx

Class MathNumerator

Hierarchy

Constructors

constructor +MathNumerator | docx

Class MathNumerator

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathPreSubSuperScript.html b/api/classes/MathPreSubSuperScript.html index 20adeb15ab..9dbbdca1f9 100644 --- a/api/classes/MathPreSubSuperScript.html +++ b/api/classes/MathPreSubSuperScript.html @@ -1,5 +1,5 @@ -MathPreSubSuperScript | docx

Class MathPreSubSuperScript

Hierarchy

Constructors

constructor +MathPreSubSuperScript | docx

Class MathPreSubSuperScript

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathPreSubSuperScriptProperties.html b/api/classes/MathPreSubSuperScriptProperties.html index d6b20fc884..e196055bdf 100644 --- a/api/classes/MathPreSubSuperScriptProperties.html +++ b/api/classes/MathPreSubSuperScriptProperties.html @@ -1,5 +1,5 @@ -MathPreSubSuperScriptProperties | docx

Class MathPreSubSuperScriptProperties

Hierarchy

Constructors

constructor +MathPreSubSuperScriptProperties | docx

Class MathPreSubSuperScriptProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathRadical.html b/api/classes/MathRadical.html index 9aa3720581..fb2ab71933 100644 --- a/api/classes/MathRadical.html +++ b/api/classes/MathRadical.html @@ -1,5 +1,5 @@ -MathRadical | docx

Class MathRadical

Hierarchy

Constructors

constructor +MathRadical | docx

Class MathRadical

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathRadicalProperties.html b/api/classes/MathRadicalProperties.html index 9b7f1f8edf..8f96fa7825 100644 --- a/api/classes/MathRadicalProperties.html +++ b/api/classes/MathRadicalProperties.html @@ -1,5 +1,5 @@ -MathRadicalProperties | docx

Class MathRadicalProperties

Hierarchy

Constructors

constructor +MathRadicalProperties | docx

Class MathRadicalProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathRoundBrackets.html b/api/classes/MathRoundBrackets.html index 95c1642700..e785594f1b 100644 --- a/api/classes/MathRoundBrackets.html +++ b/api/classes/MathRoundBrackets.html @@ -1,5 +1,5 @@ -MathRoundBrackets | docx

Class MathRoundBrackets

Hierarchy

Constructors

constructor +MathRoundBrackets | docx

Class MathRoundBrackets

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathRun.html b/api/classes/MathRun.html index 0c95cb79fc..886b570b42 100644 --- a/api/classes/MathRun.html +++ b/api/classes/MathRun.html @@ -1,5 +1,5 @@ -MathRun | docx

Class MathRun

Hierarchy

Constructors

constructor +MathRun | docx

Class MathRun

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathSquareBrackets.html b/api/classes/MathSquareBrackets.html index 4a13c0af84..eb7301edb7 100644 --- a/api/classes/MathSquareBrackets.html +++ b/api/classes/MathSquareBrackets.html @@ -1,5 +1,5 @@ -MathSquareBrackets | docx

Class MathSquareBrackets

Hierarchy

Constructors

constructor +MathSquareBrackets | docx

Class MathSquareBrackets

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathSubScript.html b/api/classes/MathSubScript.html index c12cc4a8eb..36e26e9db9 100644 --- a/api/classes/MathSubScript.html +++ b/api/classes/MathSubScript.html @@ -1,5 +1,5 @@ -MathSubScript | docx

Class MathSubScript

Hierarchy

Constructors

constructor +MathSubScript | docx

Class MathSubScript

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathSubScriptElement.html b/api/classes/MathSubScriptElement.html index ba44302bc8..f7ae0b0bfa 100644 --- a/api/classes/MathSubScriptElement.html +++ b/api/classes/MathSubScriptElement.html @@ -1,5 +1,5 @@ -MathSubScriptElement | docx

Class MathSubScriptElement

Hierarchy

Constructors

constructor +MathSubScriptElement | docx

Class MathSubScriptElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathSubScriptProperties.html b/api/classes/MathSubScriptProperties.html index efee54f325..a98b000486 100644 --- a/api/classes/MathSubScriptProperties.html +++ b/api/classes/MathSubScriptProperties.html @@ -1,5 +1,5 @@ -MathSubScriptProperties | docx

Class MathSubScriptProperties

Hierarchy

Constructors

constructor +MathSubScriptProperties | docx

Class MathSubScriptProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathSubSuperScript.html b/api/classes/MathSubSuperScript.html index fe127b6133..af97bafe32 100644 --- a/api/classes/MathSubSuperScript.html +++ b/api/classes/MathSubSuperScript.html @@ -1,5 +1,5 @@ -MathSubSuperScript | docx

Class MathSubSuperScript

Hierarchy

Constructors

constructor +MathSubSuperScript | docx

Class MathSubSuperScript

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathSubSuperScriptProperties.html b/api/classes/MathSubSuperScriptProperties.html index b36238baa1..100ef05ad4 100644 --- a/api/classes/MathSubSuperScriptProperties.html +++ b/api/classes/MathSubSuperScriptProperties.html @@ -1,5 +1,5 @@ -MathSubSuperScriptProperties | docx

Class MathSubSuperScriptProperties

Hierarchy

Constructors

constructor +MathSubSuperScriptProperties | docx

Class MathSubSuperScriptProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathSum.html b/api/classes/MathSum.html index e23d71572a..ed14249e60 100644 --- a/api/classes/MathSum.html +++ b/api/classes/MathSum.html @@ -1,5 +1,5 @@ -MathSum | docx

Class MathSum

Hierarchy

Constructors

constructor +MathSum | docx

Class MathSum

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathSuperScript.html b/api/classes/MathSuperScript.html index 1881da90ef..8475701d46 100644 --- a/api/classes/MathSuperScript.html +++ b/api/classes/MathSuperScript.html @@ -1,5 +1,5 @@ -MathSuperScript | docx

Class MathSuperScript

Hierarchy

Constructors

constructor +MathSuperScript | docx

Class MathSuperScript

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathSuperScriptElement.html b/api/classes/MathSuperScriptElement.html index 5d34ed3e64..baf2a6edde 100644 --- a/api/classes/MathSuperScriptElement.html +++ b/api/classes/MathSuperScriptElement.html @@ -1,5 +1,5 @@ -MathSuperScriptElement | docx

Class MathSuperScriptElement

Hierarchy

Constructors

constructor +MathSuperScriptElement | docx

Class MathSuperScriptElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MathSuperScriptProperties.html b/api/classes/MathSuperScriptProperties.html index 6c0ecd3395..bd92c9a92a 100644 --- a/api/classes/MathSuperScriptProperties.html +++ b/api/classes/MathSuperScriptProperties.html @@ -1,5 +1,5 @@ -MathSuperScriptProperties | docx

Class MathSuperScriptProperties

Hierarchy

Constructors

constructor +MathSuperScriptProperties | docx

Class MathSuperScriptProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Media.html b/api/classes/Media.html index 55f7a90eb6..960211a0b0 100644 --- a/api/classes/Media.html +++ b/api/classes/Media.html @@ -1,4 +1,4 @@ -Media | docx

Class Media

Constructors

constructor +Media | docx

Class Media

Constructors

constructor

Accessors

Array

Methods

addImage -

Constructors

constructor

Accessors

Array

Methods

addImage

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Accessors

Array

Methods

addImage

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MonthLong.html b/api/classes/MonthLong.html index 6eaf5fe692..1e94e64587 100644 --- a/api/classes/MonthLong.html +++ b/api/classes/MonthLong.html @@ -1,5 +1,5 @@ -MonthLong | docx

Class MonthLong

Hierarchy

Constructors

constructor +MonthLong | docx

Class MonthLong

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/MonthShort.html b/api/classes/MonthShort.html index 0779d6063a..553826e109 100644 --- a/api/classes/MonthShort.html +++ b/api/classes/MonthShort.html @@ -1,5 +1,5 @@ -MonthShort | docx

Class MonthShort

Hierarchy

Constructors

constructor +MonthShort | docx

Class MonthShort

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/NextAttributeComponent.html b/api/classes/NextAttributeComponent.html index 97e80f9dc3..7251bf14a0 100644 --- a/api/classes/NextAttributeComponent.html +++ b/api/classes/NextAttributeComponent.html @@ -1,3 +1,3 @@ -NextAttributeComponent | docx

Class NextAttributeComponent<T>

Type Parameters

Hierarchy

Constructors

constructor +NextAttributeComponent | docx

Class NextAttributeComponent<T>

Type Parameters

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/NoBreakHyphen.html b/api/classes/NoBreakHyphen.html index 6134baf458..6b72f16a83 100644 --- a/api/classes/NoBreakHyphen.html +++ b/api/classes/NoBreakHyphen.html @@ -1,5 +1,5 @@ -NoBreakHyphen | docx

Class NoBreakHyphen

Hierarchy

Constructors

constructor +NoBreakHyphen | docx

Class NoBreakHyphen

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/NumberProperties.html b/api/classes/NumberProperties.html index d40b20c85c..d9ac580eb7 100644 --- a/api/classes/NumberProperties.html +++ b/api/classes/NumberProperties.html @@ -1,5 +1,5 @@ -NumberProperties | docx

Class NumberProperties

Hierarchy

Constructors

constructor +NumberProperties | docx

Class NumberProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/NumberValueElement.html b/api/classes/NumberValueElement.html index 40c98fee05..039577c249 100644 --- a/api/classes/NumberValueElement.html +++ b/api/classes/NumberValueElement.html @@ -1,5 +1,5 @@ -NumberValueElement | docx

Class NumberValueElement

Hierarchy

Constructors

constructor +NumberValueElement | docx

Class NumberValueElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Numbering.html b/api/classes/Numbering.html index 5aa2fc0523..1a0fb57d56 100644 --- a/api/classes/Numbering.html +++ b/api/classes/Numbering.html @@ -1,8 +1,8 @@ -Numbering | docx

Class Numbering

Hierarchy

Constructors

constructor +Numbering | docx

Class Numbering

Hierarchy

Constructors

constructor

Accessors

ConcreteNumbering ReferenceConfig

Methods

addChildElement createConcreteNumberingInstance prepForXml -

Constructors

constructor

Accessors

ConcreteNumbering

ReferenceConfig

Methods

addChildElement

createConcreteNumberingInstance

  • createConcreteNumberingInstance(reference, instance): void

  • Parameters

    • reference: string
    • instance: number

    Returns void

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Accessors

ConcreteNumbering

ReferenceConfig

Methods

addChildElement

createConcreteNumberingInstance

  • createConcreteNumberingInstance(reference, instance): void

  • Parameters

    • reference: string
    • instance: number

    Returns void

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/OnOffElement.html b/api/classes/OnOffElement.html index 22a5d23aa5..a0d49fabd2 100644 --- a/api/classes/OnOffElement.html +++ b/api/classes/OnOffElement.html @@ -1,5 +1,5 @@ -OnOffElement | docx

Class OnOffElement

Hierarchy

Constructors

constructor +OnOffElement | docx

Class OnOffElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/OutlineLevel.html b/api/classes/OutlineLevel.html index 660b51a0b2..5960e9ae05 100644 --- a/api/classes/OutlineLevel.html +++ b/api/classes/OutlineLevel.html @@ -1,6 +1,6 @@ -OutlineLevel | docx

Class OutlineLevel

Hierarchy

Constructors

constructor +OutlineLevel | docx

Class OutlineLevel

Hierarchy

Constructors

constructor

Properties

level

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonly level

level: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly level

level: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Packer.html b/api/classes/Packer.html index 9e36e77506..af02f548a0 100644 --- a/api/classes/Packer.html +++ b/api/classes/Packer.html @@ -1,7 +1,7 @@ -Packer | docx

Class Packer

Constructors

constructor +Packer | docx

Class Packer

Constructors

constructor

Methods

toBase64String toBlob toBuffer toStream toString -

Constructors

constructor

Methods

Static toBase64String

  • toBase64String(file, prettify?): Promise<string>

  • Parameters

    • file: Document
    • Optional prettify: boolean | "" | " " | " " | "\t"

    Returns Promise<string>

Static toBlob

  • toBlob(file, prettify?): Promise<Blob>

  • Parameters

    • file: Document
    • Optional prettify: boolean | "" | " " | " " | "\t"

    Returns Promise<Blob>

Static toBuffer

  • toBuffer(file, prettify?): Promise<Buffer>

  • Parameters

    • file: Document
    • Optional prettify: boolean | "" | " " | " " | "\t"

    Returns Promise<Buffer>

Static toStream

Static toString

  • toString(file, prettify?): Promise<string>

  • Parameters

    • file: Document
    • Optional prettify: boolean | "" | " " | " " | "\t"

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

Static toBase64String

  • toBase64String(file, prettify?): Promise<string>

  • Parameters

    • file: Document
    • Optional prettify: boolean | "" | " " | " " | "\t"

    Returns Promise<string>

Static toBlob

  • toBlob(file, prettify?): Promise<Blob>

  • Parameters

    • file: Document
    • Optional prettify: boolean | "" | " " | " " | "\t"

    Returns Promise<Blob>

Static toBuffer

  • toBuffer(file, prettify?): Promise<Buffer>

  • Parameters

    • file: Document
    • Optional prettify: boolean | "" | " " | " " | "\t"

    Returns Promise<Buffer>

Static toStream

Static toString

  • toString(file, prettify?): Promise<string>

  • Parameters

    • file: Document
    • Optional prettify: boolean | "" | " " | " " | "\t"

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/PageBorders.html b/api/classes/PageBorders.html index b87cf35c4f..4c5efd61a5 100644 --- a/api/classes/PageBorders.html +++ b/api/classes/PageBorders.html @@ -1,5 +1,5 @@ -PageBorders | docx

Class PageBorders

Hierarchy

Constructors

constructor +PageBorders | docx

Class PageBorders

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/PageBreak.html b/api/classes/PageBreak.html index 743b2ddfe4..fa93812912 100644 --- a/api/classes/PageBreak.html +++ b/api/classes/PageBreak.html @@ -1,5 +1,5 @@ -PageBreak | docx

Class PageBreak

Hierarchy

Constructors

constructor +PageBreak | docx

Class PageBreak

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/PageBreakBefore.html b/api/classes/PageBreakBefore.html index 6ecf45eee6..20198504a7 100644 --- a/api/classes/PageBreakBefore.html +++ b/api/classes/PageBreakBefore.html @@ -1,6 +1,6 @@ PageBreakBefore | docx

Class PageBreakBefore

Add page break before the paragraph if there is no one added before.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/PageMargin.html b/api/classes/PageMargin.html index 5399427a90..1d81331056 100644 --- a/api/classes/PageMargin.html +++ b/api/classes/PageMargin.html @@ -1,5 +1,5 @@ -PageMargin | docx

Class PageMargin

Hierarchy

Constructors

constructor +PageMargin | docx

Class PageMargin

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

  • new PageMargin(top, right, bottom, left, header, footer, gutter): PageMargin

  • Parameters

    • top: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`
    • right: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`
    • bottom: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`
    • left: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`
    • header: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`
    • footer: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`
    • gutter: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

    Returns PageMargin

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

  • new PageMargin(top, right, bottom, left, header, footer, gutter): PageMargin

  • Parameters

    • top: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`
    • right: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`
    • bottom: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`
    • left: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`
    • header: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`
    • footer: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`
    • gutter: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

    Returns PageMargin

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/PageNumberElement.html b/api/classes/PageNumberElement.html index fdd1d6eacf..489f05c8c3 100644 --- a/api/classes/PageNumberElement.html +++ b/api/classes/PageNumberElement.html @@ -1,5 +1,5 @@ -PageNumberElement | docx

Class PageNumberElement

Hierarchy

Constructors

constructor +PageNumberElement | docx

Class PageNumberElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/PageNumberType.html b/api/classes/PageNumberType.html index f5d2b96946..1748785028 100644 --- a/api/classes/PageNumberType.html +++ b/api/classes/PageNumberType.html @@ -1,5 +1,5 @@ -PageNumberType | docx

Class PageNumberType

Hierarchy

Constructors

constructor +PageNumberType | docx

Class PageNumberType

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/PageNumberTypeAttributes.html b/api/classes/PageNumberTypeAttributes.html index a1b9b8afc6..f7d56c9bde 100644 --- a/api/classes/PageNumberTypeAttributes.html +++ b/api/classes/PageNumberTypeAttributes.html @@ -1,3 +1,3 @@ -PageNumberTypeAttributes | docx

Class PageNumberTypeAttributes

Hierarchy

Constructors

constructor +PageNumberTypeAttributes | docx

Class PageNumberTypeAttributes

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/PageReference.html b/api/classes/PageReference.html index c405842830..50f91739f5 100644 --- a/api/classes/PageReference.html +++ b/api/classes/PageReference.html @@ -1,5 +1,5 @@ -PageReference | docx

Class PageReference

Hierarchy

  • Run
    • PageReference

Constructors

constructor +PageReference | docx

Class PageReference

Hierarchy

  • Run
    • PageReference

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/PageSize.html b/api/classes/PageSize.html index 24ad138713..4f756ebe0e 100644 --- a/api/classes/PageSize.html +++ b/api/classes/PageSize.html @@ -1,5 +1,5 @@ -PageSize | docx

Class PageSize

Hierarchy

Constructors

constructor +PageSize | docx

Class PageSize

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/PageTextDirection.html b/api/classes/PageTextDirection.html index 57d2e08c40..3b8ef63efb 100644 --- a/api/classes/PageTextDirection.html +++ b/api/classes/PageTextDirection.html @@ -1,5 +1,5 @@ -PageTextDirection | docx

Class PageTextDirection

Hierarchy

Constructors

constructor +PageTextDirection | docx

Class PageTextDirection

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Paragraph.html b/api/classes/Paragraph.html index dfbe027e57..626c2ecb3c 100644 --- a/api/classes/Paragraph.html +++ b/api/classes/Paragraph.html @@ -1,7 +1,7 @@ -Paragraph | docx

Class Paragraph

Hierarchy

  • FileChild
    • Paragraph

Constructors

constructor +Paragraph | docx

Class Paragraph

Hierarchy

  • FileChild
    • Paragraph

Constructors

constructor

Properties

fileChild

Methods

addChildElement addRunToFront prepForXml -

Constructors

constructor

Properties

Readonly fileChild

fileChild: symbol = ...

Methods

addChildElement

addRunToFront

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly fileChild

fileChild: symbol = ...

Methods

addChildElement

addRunToFront

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/ParagraphProperties.html b/api/classes/ParagraphProperties.html index 1630bbb20b..b7d55ecf68 100644 --- a/api/classes/ParagraphProperties.html +++ b/api/classes/ParagraphProperties.html @@ -1,6 +1,6 @@ -ParagraphProperties | docx

Class ParagraphProperties

Hierarchy

Constructors

constructor +ParagraphProperties | docx

Class ParagraphProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml push -

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/ParagraphPropertiesDefaults.html b/api/classes/ParagraphPropertiesDefaults.html index 48a6ab769d..67d18e8571 100644 --- a/api/classes/ParagraphPropertiesDefaults.html +++ b/api/classes/ParagraphPropertiesDefaults.html @@ -1,5 +1,5 @@ -ParagraphPropertiesDefaults | docx

Class ParagraphPropertiesDefaults

Hierarchy

Constructors

constructor +ParagraphPropertiesDefaults | docx

Class ParagraphPropertiesDefaults

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/PositionalTab.html b/api/classes/PositionalTab.html index b0d1aa528c..a4745b30c9 100644 --- a/api/classes/PositionalTab.html +++ b/api/classes/PositionalTab.html @@ -1,5 +1,5 @@ -PositionalTab | docx

Class PositionalTab

Hierarchy

Constructors

constructor +PositionalTab | docx

Class PositionalTab

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Run.html b/api/classes/Run.html index 014d9b9774..868bb6acfb 100644 --- a/api/classes/Run.html +++ b/api/classes/Run.html @@ -1,5 +1,5 @@ -Run | docx

Class Run

Hierarchy

Constructors

constructor +Run | docx

Class Run

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/RunFonts.html b/api/classes/RunFonts.html index 61dee6618f..00a1f59fc3 100644 --- a/api/classes/RunFonts.html +++ b/api/classes/RunFonts.html @@ -1,5 +1,5 @@ -RunFonts | docx

Class RunFonts

Hierarchy

Constructors

constructor +RunFonts | docx

Class RunFonts

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/RunProperties.html b/api/classes/RunProperties.html index 7fb3257812..c443579a47 100644 --- a/api/classes/RunProperties.html +++ b/api/classes/RunProperties.html @@ -1,6 +1,6 @@ -RunProperties | docx

Class RunProperties

Hierarchy

Constructors

constructor +RunProperties | docx

Class RunProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml push -

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/RunPropertiesChange.html b/api/classes/RunPropertiesChange.html index 6ac9fb69e4..0113f9a4ca 100644 --- a/api/classes/RunPropertiesChange.html +++ b/api/classes/RunPropertiesChange.html @@ -1,5 +1,5 @@ -RunPropertiesChange | docx

Class RunPropertiesChange

Hierarchy

Constructors

constructor +RunPropertiesChange | docx

Class RunPropertiesChange

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/RunPropertiesDefaults.html b/api/classes/RunPropertiesDefaults.html index 73c784e336..bd61691ee5 100644 --- a/api/classes/RunPropertiesDefaults.html +++ b/api/classes/RunPropertiesDefaults.html @@ -1,5 +1,5 @@ -RunPropertiesDefaults | docx

Class RunPropertiesDefaults

Hierarchy

Constructors

constructor +RunPropertiesDefaults | docx

Class RunPropertiesDefaults

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/SectionProperties.html b/api/classes/SectionProperties.html index 6b21a125dd..06f98aa4ed 100644 --- a/api/classes/SectionProperties.html +++ b/api/classes/SectionProperties.html @@ -1,5 +1,5 @@ -SectionProperties | docx

Class SectionProperties

Hierarchy

Constructors

constructor +SectionProperties | docx

Class SectionProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/SectionTypeAttributes.html b/api/classes/SectionTypeAttributes.html index 9633d70f05..fc83c02315 100644 --- a/api/classes/SectionTypeAttributes.html +++ b/api/classes/SectionTypeAttributes.html @@ -1,3 +1,3 @@ -SectionTypeAttributes | docx

Class SectionTypeAttributes

Hierarchy

Constructors

constructor +SectionTypeAttributes | docx

Class SectionTypeAttributes

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Separator.html b/api/classes/Separator.html index a68b2853e0..59b2c6de5d 100644 --- a/api/classes/Separator.html +++ b/api/classes/Separator.html @@ -1,5 +1,5 @@ -Separator | docx

Class Separator

Hierarchy

Constructors

constructor +Separator | docx

Class Separator

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/SequentialIdentifier.html b/api/classes/SequentialIdentifier.html index a555528652..3db91140fd 100644 --- a/api/classes/SequentialIdentifier.html +++ b/api/classes/SequentialIdentifier.html @@ -1,5 +1,5 @@ -SequentialIdentifier | docx

Class SequentialIdentifier

Hierarchy

  • Run
    • SequentialIdentifier

Constructors

constructor +SequentialIdentifier | docx

Class SequentialIdentifier

Hierarchy

  • Run
    • SequentialIdentifier

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Shading.html b/api/classes/Shading.html index 6948b1c9ca..a226c85899 100644 --- a/api/classes/Shading.html +++ b/api/classes/Shading.html @@ -1,5 +1,5 @@ -Shading | docx

Class Shading

Hierarchy

Constructors

constructor +Shading | docx

Class Shading

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/SimpleField.html b/api/classes/SimpleField.html index a6a01f3d87..39444655fb 100644 --- a/api/classes/SimpleField.html +++ b/api/classes/SimpleField.html @@ -1,5 +1,5 @@ -SimpleField | docx

Class SimpleField

Hierarchy

Constructors

constructor +SimpleField | docx

Class SimpleField

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/SimpleMailMergeField.html b/api/classes/SimpleMailMergeField.html index 0c0d359530..e18cc679d6 100644 --- a/api/classes/SimpleMailMergeField.html +++ b/api/classes/SimpleMailMergeField.html @@ -1,5 +1,5 @@ -SimpleMailMergeField | docx

Class SimpleMailMergeField

Hierarchy

Constructors

constructor +SimpleMailMergeField | docx

Class SimpleMailMergeField

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/SimplePos.html b/api/classes/SimplePos.html index 5b47882dba..bb885cd8ba 100644 --- a/api/classes/SimplePos.html +++ b/api/classes/SimplePos.html @@ -1,5 +1,5 @@ -SimplePos | docx

Class SimplePos

Hierarchy

Constructors

constructor +SimplePos | docx

Class SimplePos

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/SoftHyphen.html b/api/classes/SoftHyphen.html index cc4013b39d..b6f578d16f 100644 --- a/api/classes/SoftHyphen.html +++ b/api/classes/SoftHyphen.html @@ -1,5 +1,5 @@ -SoftHyphen | docx

Class SoftHyphen

Hierarchy

Constructors

constructor +SoftHyphen | docx

Class SoftHyphen

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Spacing.html b/api/classes/Spacing.html index 2fcb639108..4d10705cd5 100644 --- a/api/classes/Spacing.html +++ b/api/classes/Spacing.html @@ -1,5 +1,5 @@ -Spacing | docx

Class Spacing

Hierarchy

Constructors

constructor +Spacing | docx

Class Spacing

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/StringContainer.html b/api/classes/StringContainer.html index 976d52dd67..a412ea5de7 100644 --- a/api/classes/StringContainer.html +++ b/api/classes/StringContainer.html @@ -1,5 +1,5 @@ -StringContainer | docx

Class StringContainer

Hierarchy

Constructors

constructor +StringContainer | docx

Class StringContainer

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/StringEnumValueElement.html b/api/classes/StringEnumValueElement.html index 0efb188c41..a1a661ee84 100644 --- a/api/classes/StringEnumValueElement.html +++ b/api/classes/StringEnumValueElement.html @@ -1,5 +1,5 @@ -StringEnumValueElement | docx

Class StringEnumValueElement<T>

Type Parameters

  • T extends string

Hierarchy

Constructors

constructor +StringEnumValueElement | docx

Class StringEnumValueElement<T>

Type Parameters

  • T extends string

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/StringValueElement.html b/api/classes/StringValueElement.html index 3850213360..89e5328e0f 100644 --- a/api/classes/StringValueElement.html +++ b/api/classes/StringValueElement.html @@ -1,5 +1,5 @@ -StringValueElement | docx

Class StringValueElement

Hierarchy

Constructors

constructor +StringValueElement | docx

Class StringValueElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Style.html b/api/classes/Style.html index cdf829eee4..554302e51b 100644 --- a/api/classes/Style.html +++ b/api/classes/Style.html @@ -1,5 +1,5 @@ -Style | docx

Class Style

Hierarchy

Constructors

constructor +Style | docx

Class Style

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/StyleForCharacter.html b/api/classes/StyleForCharacter.html index 41dfcaba87..976afe174c 100644 --- a/api/classes/StyleForCharacter.html +++ b/api/classes/StyleForCharacter.html @@ -1,5 +1,5 @@ -StyleForCharacter | docx

Class StyleForCharacter

Hierarchy

  • Style
    • StyleForCharacter

Constructors

constructor +StyleForCharacter | docx

Class StyleForCharacter

Hierarchy

  • Style
    • StyleForCharacter

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/StyleForParagraph.html b/api/classes/StyleForParagraph.html index 4bd5ccb8de..a3981602c1 100644 --- a/api/classes/StyleForParagraph.html +++ b/api/classes/StyleForParagraph.html @@ -1,5 +1,5 @@ -StyleForParagraph | docx

Class StyleForParagraph

Hierarchy

  • Style
    • StyleForParagraph

Constructors

constructor +StyleForParagraph | docx

Class StyleForParagraph

Hierarchy

  • Style
    • StyleForParagraph

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/StyleLevel.html b/api/classes/StyleLevel.html index 00b8021727..2747fe173a 100644 --- a/api/classes/StyleLevel.html +++ b/api/classes/StyleLevel.html @@ -1,4 +1,4 @@ -StyleLevel | docx

Class StyleLevel

Constructors

constructor +StyleLevel | docx

Class StyleLevel

Constructors

constructor

Properties

level styleName -

Constructors

constructor

Properties

Readonly level

level: number

Readonly styleName

styleName: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly level

level: number

Readonly styleName

styleName: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Styles.html b/api/classes/Styles.html index 97b6996f10..29a51e9112 100644 --- a/api/classes/Styles.html +++ b/api/classes/Styles.html @@ -1,5 +1,5 @@ -Styles | docx

Class Styles

Hierarchy

Constructors

constructor +Styles | docx

Class Styles

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/SymbolRun.html b/api/classes/SymbolRun.html index c7254852b4..f03e99bbfd 100644 --- a/api/classes/SymbolRun.html +++ b/api/classes/SymbolRun.html @@ -1,5 +1,5 @@ -SymbolRun | docx

Class SymbolRun

Hierarchy

Constructors

constructor +SymbolRun | docx

Class SymbolRun

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TDirection.html b/api/classes/TDirection.html index 1ab27f71d9..0d35f2b774 100644 --- a/api/classes/TDirection.html +++ b/api/classes/TDirection.html @@ -1,6 +1,6 @@ TDirection | docx

Class TDirection

Text Direction within a table cell

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Tab.html b/api/classes/Tab.html index d5f2efd85e..83380c9e48 100644 --- a/api/classes/Tab.html +++ b/api/classes/Tab.html @@ -1,5 +1,5 @@ -Tab | docx

Class Tab

Hierarchy

Constructors

constructor +Tab | docx

Class Tab

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TabAttributes.html b/api/classes/TabAttributes.html index 240a58a224..d531817c6f 100644 --- a/api/classes/TabAttributes.html +++ b/api/classes/TabAttributes.html @@ -1,3 +1,3 @@ -TabAttributes | docx

Class TabAttributes

Hierarchy

Constructors

constructor +TabAttributes | docx

Class TabAttributes

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new TabAttributes(root): TabAttributes

  • Parameters

    • root: {
          leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot";
          pos: string | number;
          val: "center" | "clear" | "left" | "right" | "start" | "end" | "decimal" | "bar" | "num";
      }
      • Optional Readonly leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot"
      • Readonly pos: string | number
      • Readonly val: "center" | "clear" | "left" | "right" | "start" | "end" | "decimal" | "bar" | "num"

    Returns TabAttributes

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

  • new TabAttributes(root): TabAttributes

  • Parameters

    • root: {
          leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot";
          pos: string | number;
          val: "center" | "clear" | "left" | "right" | "start" | "end" | "decimal" | "bar" | "num";
      }
      • Optional Readonly leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot"
      • Readonly pos: string | number
      • Readonly val: "center" | "clear" | "left" | "right" | "start" | "end" | "decimal" | "bar" | "num"

    Returns TabAttributes

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TabStop.html b/api/classes/TabStop.html index 4c77896321..c5f3fda24e 100644 --- a/api/classes/TabStop.html +++ b/api/classes/TabStop.html @@ -1,5 +1,5 @@ -TabStop | docx

Class TabStop

Hierarchy

Constructors

constructor +TabStop | docx

Class TabStop

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TabStopItem.html b/api/classes/TabStopItem.html index 46efe219ef..9a6452ba65 100644 --- a/api/classes/TabStopItem.html +++ b/api/classes/TabStopItem.html @@ -1,5 +1,5 @@ -TabStopItem | docx

Class TabStopItem

Hierarchy

Constructors

constructor +TabStopItem | docx

Class TabStopItem

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Table.html b/api/classes/Table.html index 95e881108f..31f1501b92 100644 --- a/api/classes/Table.html +++ b/api/classes/Table.html @@ -1,6 +1,6 @@ -Table | docx

Class Table

Hierarchy

  • FileChild
    • Table

Constructors

constructor +Table | docx

Class Table

Hierarchy

  • FileChild
    • Table

Constructors

constructor

Properties

fileChild

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonly fileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly fileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TableBorders.html b/api/classes/TableBorders.html index 47b1ddb75e..959504fbf0 100644 --- a/api/classes/TableBorders.html +++ b/api/classes/TableBorders.html @@ -1,6 +1,6 @@ -TableBorders | docx

Class TableBorders

Hierarchy

Constructors

constructor +TableBorders | docx

Class TableBorders

Hierarchy

Constructors

constructor

Properties

NONE

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Static Readonly NONE

NONE: {
    bottom: {
        color: string;
        size: number;
        style: "none";
    };
    insideHorizontal: {
        color: string;
        size: number;
        style: "none";
    };
    insideVertical: {
        color: string;
        size: number;
        style: "none";
    };
    left: {
        color: string;
        size: number;
        style: "none";
    };
    right: {
        color: string;
        size: number;
        style: "none";
    };
    top: {
        color: string;
        size: number;
        style: "none";
    };
} = ...

Type declaration

  • bottom: {
        color: string;
        size: number;
        style: "none";
    }
    • color: string
    • size: number
    • style: "none"
  • insideHorizontal: {
        color: string;
        size: number;
        style: "none";
    }
    • color: string
    • size: number
    • style: "none"
  • insideVertical: {
        color: string;
        size: number;
        style: "none";
    }
    • color: string
    • size: number
    • style: "none"
  • left: {
        color: string;
        size: number;
        style: "none";
    }
    • color: string
    • size: number
    • style: "none"
  • right: {
        color: string;
        size: number;
        style: "none";
    }
    • color: string
    • size: number
    • style: "none"
  • top: {
        color: string;
        size: number;
        style: "none";
    }
    • color: string
    • size: number
    • style: "none"

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly NONE

NONE: {
    bottom: {
        color: string;
        size: number;
        style: "none";
    };
    insideHorizontal: {
        color: string;
        size: number;
        style: "none";
    };
    insideVertical: {
        color: string;
        size: number;
        style: "none";
    };
    left: {
        color: string;
        size: number;
        style: "none";
    };
    right: {
        color: string;
        size: number;
        style: "none";
    };
    top: {
        color: string;
        size: number;
        style: "none";
    };
} = ...

Type declaration

  • bottom: {
        color: string;
        size: number;
        style: "none";
    }
    • color: string
    • size: number
    • style: "none"
  • insideHorizontal: {
        color: string;
        size: number;
        style: "none";
    }
    • color: string
    • size: number
    • style: "none"
  • insideVertical: {
        color: string;
        size: number;
        style: "none";
    }
    • color: string
    • size: number
    • style: "none"
  • left: {
        color: string;
        size: number;
        style: "none";
    }
    • color: string
    • size: number
    • style: "none"
  • right: {
        color: string;
        size: number;
        style: "none";
    }
    • color: string
    • size: number
    • style: "none"
  • top: {
        color: string;
        size: number;
        style: "none";
    }
    • color: string
    • size: number
    • style: "none"

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TableCell.html b/api/classes/TableCell.html index aa3ff6403f..fdefb96d01 100644 --- a/api/classes/TableCell.html +++ b/api/classes/TableCell.html @@ -1,6 +1,6 @@ -TableCell | docx

Class TableCell

Hierarchy

Constructors

constructor +TableCell | docx

Class TableCell

Hierarchy

Constructors

constructor

Properties

options

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonly options

options: ITableCellOptions

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly options

options: ITableCellOptions

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TableCellBorders.html b/api/classes/TableCellBorders.html index 313fb7ec75..fa5e3c675b 100644 --- a/api/classes/TableCellBorders.html +++ b/api/classes/TableCellBorders.html @@ -1,5 +1,5 @@ -TableCellBorders | docx

Class TableCellBorders

Hierarchy

Constructors

constructor +TableCellBorders | docx

Class TableCellBorders

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TableFloatProperties.html b/api/classes/TableFloatProperties.html index 6986cde236..0095343056 100644 --- a/api/classes/TableFloatProperties.html +++ b/api/classes/TableFloatProperties.html @@ -1,5 +1,5 @@ -TableFloatProperties | docx

Class TableFloatProperties

Hierarchy

Constructors

constructor +TableFloatProperties | docx

Class TableFloatProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TableLayout.html b/api/classes/TableLayout.html index 16a4cc8180..82033c09d0 100644 --- a/api/classes/TableLayout.html +++ b/api/classes/TableLayout.html @@ -1,5 +1,5 @@ -TableLayout | docx

Class TableLayout

Hierarchy

Constructors

constructor +TableLayout | docx

Class TableLayout

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TableOfContents.html b/api/classes/TableOfContents.html index 77a0b5f3ce..9b6e2c4231 100644 --- a/api/classes/TableOfContents.html +++ b/api/classes/TableOfContents.html @@ -1,6 +1,6 @@ -TableOfContents | docx

Class TableOfContents

Hierarchy

  • FileChild
    • TableOfContents

Constructors

constructor +TableOfContents | docx

Class TableOfContents

Hierarchy

  • FileChild
    • TableOfContents

Constructors

constructor

Properties

fileChild

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonly fileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly fileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TableProperties.html b/api/classes/TableProperties.html index 050f667cc4..efbd5cb6f3 100644 --- a/api/classes/TableProperties.html +++ b/api/classes/TableProperties.html @@ -1,5 +1,5 @@ -TableProperties | docx

Class TableProperties

Hierarchy

Constructors

constructor +TableProperties | docx

Class TableProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TableRow.html b/api/classes/TableRow.html index 970e0e2078..92fbd5d2f1 100644 --- a/api/classes/TableRow.html +++ b/api/classes/TableRow.html @@ -1,4 +1,4 @@ -TableRow | docx

Class TableRow

Hierarchy

Constructors

constructor +TableRow | docx

Class TableRow

Hierarchy

Constructors

constructor

Accessors

CellCount cells

Methods

addCellToColumnIndex @@ -7,5 +7,5 @@ columnIndexToRootIndex prepForXml rootIndexToColumnIndex -

Constructors

constructor

Accessors

CellCount

cells

Methods

addCellToColumnIndex

addCellToIndex

addChildElement

columnIndexToRootIndex

  • columnIndexToRootIndex(columnIndex, allowEndNewCell?): number

  • Parameters

    • columnIndex: number
    • allowEndNewCell: boolean = false

    Returns number

prepForXml

rootIndexToColumnIndex

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Accessors

CellCount

cells

Methods

addCellToColumnIndex

addCellToIndex

addChildElement

columnIndexToRootIndex

  • columnIndexToRootIndex(columnIndex, allowEndNewCell?): number

  • Parameters

    • columnIndex: number
    • allowEndNewCell: boolean = false

    Returns number

prepForXml

rootIndexToColumnIndex

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TableRowHeight.html b/api/classes/TableRowHeight.html index b36c5d7270..1de0d30efd 100644 --- a/api/classes/TableRowHeight.html +++ b/api/classes/TableRowHeight.html @@ -1,5 +1,5 @@ -TableRowHeight | docx

Class TableRowHeight

Hierarchy

Constructors

constructor +TableRowHeight | docx

Class TableRowHeight

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TableRowHeightAttributes.html b/api/classes/TableRowHeightAttributes.html index 619fedacd6..0a4120f342 100644 --- a/api/classes/TableRowHeightAttributes.html +++ b/api/classes/TableRowHeightAttributes.html @@ -1,3 +1,3 @@ -TableRowHeightAttributes | docx

Class TableRowHeightAttributes

Hierarchy

Constructors

constructor +TableRowHeightAttributes | docx

Class TableRowHeightAttributes

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TableRowProperties.html b/api/classes/TableRowProperties.html index e278c9c660..754a8fc4cc 100644 --- a/api/classes/TableRowProperties.html +++ b/api/classes/TableRowProperties.html @@ -1,5 +1,5 @@ -TableRowProperties | docx

Class TableRowProperties

Hierarchy

Constructors

constructor +TableRowProperties | docx

Class TableRowProperties

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TableWidthElement.html b/api/classes/TableWidthElement.html index f4f07bbc00..9c891de350 100644 --- a/api/classes/TableWidthElement.html +++ b/api/classes/TableWidthElement.html @@ -1,5 +1,5 @@ -TableWidthElement | docx

Class TableWidthElement

Hierarchy

Constructors

constructor +TableWidthElement | docx

Class TableWidthElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/TextRun.html b/api/classes/TextRun.html index 660f9dc902..b4ff31fea2 100644 --- a/api/classes/TextRun.html +++ b/api/classes/TextRun.html @@ -1,5 +1,5 @@ -TextRun | docx

Class TextRun

Hierarchy

Constructors

constructor +TextRun | docx

Class TextRun

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/ThematicBreak.html b/api/classes/ThematicBreak.html index 9c75d1424f..6de4e37e9d 100644 --- a/api/classes/ThematicBreak.html +++ b/api/classes/ThematicBreak.html @@ -1,5 +1,5 @@ -ThematicBreak | docx

Class ThematicBreak

Hierarchy

Constructors

constructor +ThematicBreak | docx

Class ThematicBreak

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Type.html b/api/classes/Type.html index d3226c2bc4..3b2934d427 100644 --- a/api/classes/Type.html +++ b/api/classes/Type.html @@ -1,5 +1,5 @@ -Type | docx

Class Type

Hierarchy

Constructors

constructor +Type | docx

Class Type

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/Underline.html b/api/classes/Underline.html index 5f90ae3b74..0b315f3fa0 100644 --- a/api/classes/Underline.html +++ b/api/classes/Underline.html @@ -1,5 +1,5 @@ -Underline | docx

Class Underline

Hierarchy

Constructors

constructor +Underline | docx

Class Underline

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

  • new Underline(underlineType?, color?): Underline

  • Parameters

    • underlineType: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble" = UnderlineType.SINGLE
    • Optional color: string

    Returns Underline

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

  • new Underline(underlineType?, color?): Underline

  • Parameters

    • underlineType: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble" = UnderlineType.SINGLE
    • Optional color: string

    Returns Underline

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/VerticalAlignAttributes.html b/api/classes/VerticalAlignAttributes.html index f6ffe51c5d..14d20d2070 100644 --- a/api/classes/VerticalAlignAttributes.html +++ b/api/classes/VerticalAlignAttributes.html @@ -1,3 +1,3 @@ -VerticalAlignAttributes | docx

Class VerticalAlignAttributes

Hierarchy

Constructors

constructor +VerticalAlignAttributes | docx

Class VerticalAlignAttributes

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/VerticalAlignElement.html b/api/classes/VerticalAlignElement.html index 180f6770d6..35332a5664 100644 --- a/api/classes/VerticalAlignElement.html +++ b/api/classes/VerticalAlignElement.html @@ -1,5 +1,5 @@ -VerticalAlignElement | docx

Class VerticalAlignElement

Hierarchy

Constructors

constructor +VerticalAlignElement | docx

Class VerticalAlignElement

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/VerticalMerge.html b/api/classes/VerticalMerge.html index f6d8730fe8..76b891a732 100644 --- a/api/classes/VerticalMerge.html +++ b/api/classes/VerticalMerge.html @@ -1,6 +1,6 @@ VerticalMerge | docx

Class VerticalMerge

Vertical merge element. Should be used in a table cell.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/VerticalPosition.html b/api/classes/VerticalPosition.html index b6377c918e..cc0afac52f 100644 --- a/api/classes/VerticalPosition.html +++ b/api/classes/VerticalPosition.html @@ -1,5 +1,5 @@ -VerticalPosition | docx

Class VerticalPosition

Hierarchy

Constructors

constructor +VerticalPosition | docx

Class VerticalPosition

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/WrapNone.html b/api/classes/WrapNone.html index c6df19248a..e722610604 100644 --- a/api/classes/WrapNone.html +++ b/api/classes/WrapNone.html @@ -1,5 +1,5 @@ -WrapNone | docx

Class WrapNone

Hierarchy

Constructors

constructor +WrapNone | docx

Class WrapNone

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/WrapSquare.html b/api/classes/WrapSquare.html index 8d74563804..6a2f83d6ba 100644 --- a/api/classes/WrapSquare.html +++ b/api/classes/WrapSquare.html @@ -1,5 +1,5 @@ -WrapSquare | docx

Class WrapSquare

Hierarchy

Constructors

constructor +WrapSquare | docx

Class WrapSquare

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/WrapTight.html b/api/classes/WrapTight.html index c8af8fe5f9..505ace3411 100644 --- a/api/classes/WrapTight.html +++ b/api/classes/WrapTight.html @@ -1,5 +1,5 @@ -WrapTight | docx

Class WrapTight

Hierarchy

Constructors

constructor +WrapTight | docx

Class WrapTight

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/WrapTopAndBottom.html b/api/classes/WrapTopAndBottom.html index 88d26ffb38..cbaf64c889 100644 --- a/api/classes/WrapTopAndBottom.html +++ b/api/classes/WrapTopAndBottom.html @@ -1,5 +1,5 @@ -WrapTopAndBottom | docx

Class WrapTopAndBottom

Hierarchy

Constructors

constructor +WrapTopAndBottom | docx

Class WrapTopAndBottom

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/XmlAttributeComponent.html b/api/classes/XmlAttributeComponent.html index 2c25b87b90..9b43176800 100644 --- a/api/classes/XmlAttributeComponent.html +++ b/api/classes/XmlAttributeComponent.html @@ -1,3 +1,3 @@ -XmlAttributeComponent | docx

Class XmlAttributeComponent<T>Abstract

Type Parameters

  • T extends object

Hierarchy

Constructors

constructor +XmlAttributeComponent | docx

Class XmlAttributeComponent<T>Abstract

Type Parameters

  • T extends object

Hierarchy

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/XmlComponent.html b/api/classes/XmlComponent.html index dff160fa2d..ef7e547580 100644 --- a/api/classes/XmlComponent.html +++ b/api/classes/XmlComponent.html @@ -1,5 +1,5 @@ -XmlComponent | docx

Class XmlComponentAbstract

Hierarchy

Constructors

constructor +XmlComponent | docx

Class XmlComponentAbstract

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/YearLong.html b/api/classes/YearLong.html index 5ae635ba6a..2f14c7d7a4 100644 --- a/api/classes/YearLong.html +++ b/api/classes/YearLong.html @@ -1,5 +1,5 @@ -YearLong | docx

Class YearLong

Hierarchy

Constructors

constructor +YearLong | docx

Class YearLong

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/classes/YearShort.html b/api/classes/YearShort.html index ceb6aebc66..906ac5f605 100644 --- a/api/classes/YearShort.html +++ b/api/classes/YearShort.html @@ -1,5 +1,5 @@ -YearShort | docx

Class YearShort

Hierarchy

Constructors

constructor +YearShort | docx

Class YearShort

Hierarchy

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/abstractNumUniqueNumericIdGen.html b/api/functions/abstractNumUniqueNumericIdGen.html index beb0a63939..259d2fb48a 100644 --- a/api/functions/abstractNumUniqueNumericIdGen.html +++ b/api/functions/abstractNumUniqueNumericIdGen.html @@ -1 +1 @@ -abstractNumUniqueNumericIdGen | docx

Function abstractNumUniqueNumericIdGen

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +abstractNumUniqueNumericIdGen | docx

Function abstractNumUniqueNumericIdGen

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/bookmarkUniqueNumericIdGen.html b/api/functions/bookmarkUniqueNumericIdGen.html index ca04aa12f4..12c19b5c17 100644 --- a/api/functions/bookmarkUniqueNumericIdGen.html +++ b/api/functions/bookmarkUniqueNumericIdGen.html @@ -1 +1 @@ -bookmarkUniqueNumericIdGen | docx

Function bookmarkUniqueNumericIdGen

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +bookmarkUniqueNumericIdGen | docx

Function bookmarkUniqueNumericIdGen

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/concreteNumUniqueNumericIdGen.html b/api/functions/concreteNumUniqueNumericIdGen.html index 08c5679e43..e4a6919bab 100644 --- a/api/functions/concreteNumUniqueNumericIdGen.html +++ b/api/functions/concreteNumUniqueNumericIdGen.html @@ -1 +1 @@ -concreteNumUniqueNumericIdGen | docx

Function concreteNumUniqueNumericIdGen

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +concreteNumUniqueNumericIdGen | docx

Function concreteNumUniqueNumericIdGen

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/convertInchesToTwip.html b/api/functions/convertInchesToTwip.html index cde4f9e058..774df94d27 100644 --- a/api/functions/convertInchesToTwip.html +++ b/api/functions/convertInchesToTwip.html @@ -1 +1 @@ -convertInchesToTwip | docx

Function convertInchesToTwip

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +convertInchesToTwip | docx

Function convertInchesToTwip

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/convertMillimetersToTwip.html b/api/functions/convertMillimetersToTwip.html index 89aed7330c..269d88f279 100644 --- a/api/functions/convertMillimetersToTwip.html +++ b/api/functions/convertMillimetersToTwip.html @@ -1 +1 @@ -convertMillimetersToTwip | docx

Function convertMillimetersToTwip

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +convertMillimetersToTwip | docx

Function convertMillimetersToTwip

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/convertToXmlComponent.html b/api/functions/convertToXmlComponent.html index 29fb014e4a..0f6473cbc1 100644 --- a/api/functions/convertToXmlComponent.html +++ b/api/functions/convertToXmlComponent.html @@ -1,3 +1,3 @@ convertToXmlComponent | docx

Function convertToXmlComponent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns undefined | string | ImportedXmlComponent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/createLineNumberType.html b/api/functions/createLineNumberType.html index 1be090c721..01230fc9c1 100644 --- a/api/functions/createLineNumberType.html +++ b/api/functions/createLineNumberType.html @@ -1 +1 @@ -createLineNumberType | docx

Function createLineNumberType

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createLineNumberType | docx

Function createLineNumberType

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/dateTimeValue.html b/api/functions/dateTimeValue.html index 465e886622..11eaaf35b7 100644 --- a/api/functions/dateTimeValue.html +++ b/api/functions/dateTimeValue.html @@ -1 +1 @@ -dateTimeValue | docx

Function dateTimeValue

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +dateTimeValue | docx

Function dateTimeValue

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/decimalNumber.html b/api/functions/decimalNumber.html index e80284e4bf..7efa7184e8 100644 --- a/api/functions/decimalNumber.html +++ b/api/functions/decimalNumber.html @@ -1 +1 @@ -decimalNumber | docx

Function decimalNumber

  • decimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +decimalNumber | docx

Function decimalNumber

  • decimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/docPropertiesUniqueNumericIdGen.html b/api/functions/docPropertiesUniqueNumericIdGen.html index d2128371dd..2adfba2284 100644 --- a/api/functions/docPropertiesUniqueNumericIdGen.html +++ b/api/functions/docPropertiesUniqueNumericIdGen.html @@ -1 +1 @@ -docPropertiesUniqueNumericIdGen | docx

Function docPropertiesUniqueNumericIdGen

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +docPropertiesUniqueNumericIdGen | docx

Function docPropertiesUniqueNumericIdGen

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/eighthPointMeasureValue.html b/api/functions/eighthPointMeasureValue.html index facc215c4b..f349a962d6 100644 --- a/api/functions/eighthPointMeasureValue.html +++ b/api/functions/eighthPointMeasureValue.html @@ -1 +1 @@ -eighthPointMeasureValue | docx

Function eighthPointMeasureValue

  • eighthPointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +eighthPointMeasureValue | docx

Function eighthPointMeasureValue

  • eighthPointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/hexColorValue.html b/api/functions/hexColorValue.html index fc00296842..b679a71369 100644 --- a/api/functions/hexColorValue.html +++ b/api/functions/hexColorValue.html @@ -1 +1 @@ -hexColorValue | docx

Function hexColorValue

  • hexColorValue(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +hexColorValue | docx

Function hexColorValue

  • hexColorValue(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/hpsMeasureValue.html b/api/functions/hpsMeasureValue.html index 7cc80de68d..6b9ce7dd0c 100644 --- a/api/functions/hpsMeasureValue.html +++ b/api/functions/hpsMeasureValue.html @@ -1 +1 @@ -hpsMeasureValue | docx

Function hpsMeasureValue

  • hpsMeasureValue(val): string | number

  • Parameters

    • val: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

    Returns string | number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +hpsMeasureValue | docx

Function hpsMeasureValue

  • hpsMeasureValue(val): string | number

  • Parameters

    • val: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

    Returns string | number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/longHexNumber.html b/api/functions/longHexNumber.html index 20eac5b047..7313f800b3 100644 --- a/api/functions/longHexNumber.html +++ b/api/functions/longHexNumber.html @@ -1 +1 @@ -longHexNumber | docx

Function longHexNumber

  • longHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +longHexNumber | docx

Function longHexNumber

  • longHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/measurementOrPercentValue.html b/api/functions/measurementOrPercentValue.html index 287b1ab48f..b2b3d4e1db 100644 --- a/api/functions/measurementOrPercentValue.html +++ b/api/functions/measurementOrPercentValue.html @@ -1 +1 @@ -measurementOrPercentValue | docx

Function measurementOrPercentValue

  • measurementOrPercentValue(val): number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi` | `${number}%` | `-${number}%`

  • Parameters

    • val: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi` | `${number}%` | `-${number}%`

    Returns number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi` | `${number}%` | `-${number}%`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +measurementOrPercentValue | docx

Function measurementOrPercentValue

  • measurementOrPercentValue(val): number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi` | `${number}%` | `-${number}%`

  • Parameters

    • val: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi` | `${number}%` | `-${number}%`

    Returns number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi` | `${number}%` | `-${number}%`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/patchDocument.html b/api/functions/patchDocument.html index a92106a53d..c6c8d22ab4 100644 --- a/api/functions/patchDocument.html +++ b/api/functions/patchDocument.html @@ -1 +1 @@ -patchDocument | docx

Function patchDocument

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +patchDocument | docx

Function patchDocument

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/percentageValue.html b/api/functions/percentageValue.html index 8d94b78eea..91e0016ebc 100644 --- a/api/functions/percentageValue.html +++ b/api/functions/percentageValue.html @@ -1 +1 @@ -percentageValue | docx

Function percentageValue

  • percentageValue(val): `${number}%` | `-${number}%`

  • Parameters

    • val: `${number}%` | `-${number}%`

    Returns `${number}%` | `-${number}%`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +percentageValue | docx

Function percentageValue

  • percentageValue(val): `${number}%` | `-${number}%`

  • Parameters

    • val: `${number}%` | `-${number}%`

    Returns `${number}%` | `-${number}%`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/pointMeasureValue.html b/api/functions/pointMeasureValue.html index 742d914a14..bf86fbd17a 100644 --- a/api/functions/pointMeasureValue.html +++ b/api/functions/pointMeasureValue.html @@ -1 +1 @@ -pointMeasureValue | docx

Function pointMeasureValue

  • pointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +pointMeasureValue | docx

Function pointMeasureValue

  • pointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/positiveUniversalMeasureValue.html b/api/functions/positiveUniversalMeasureValue.html index afc94a9f77..92592cb89a 100644 --- a/api/functions/positiveUniversalMeasureValue.html +++ b/api/functions/positiveUniversalMeasureValue.html @@ -1 +1 @@ -positiveUniversalMeasureValue | docx

Function positiveUniversalMeasureValue

  • positiveUniversalMeasureValue(val): `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

  • Parameters

    • val: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

    Returns `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +positiveUniversalMeasureValue | docx

Function positiveUniversalMeasureValue

  • positiveUniversalMeasureValue(val): `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

  • Parameters

    • val: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

    Returns `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/shortHexNumber.html b/api/functions/shortHexNumber.html index 7d1618a4d2..75accaf0ac 100644 --- a/api/functions/shortHexNumber.html +++ b/api/functions/shortHexNumber.html @@ -1 +1 @@ -shortHexNumber | docx

Function shortHexNumber

  • shortHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +shortHexNumber | docx

Function shortHexNumber

  • shortHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/signedHpsMeasureValue.html b/api/functions/signedHpsMeasureValue.html index 6b25e53490..09e2039ba7 100644 --- a/api/functions/signedHpsMeasureValue.html +++ b/api/functions/signedHpsMeasureValue.html @@ -1 +1 @@ -signedHpsMeasureValue | docx

Function signedHpsMeasureValue

  • signedHpsMeasureValue(val): string | number

  • Parameters

    • val: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

    Returns string | number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +signedHpsMeasureValue | docx

Function signedHpsMeasureValue

  • signedHpsMeasureValue(val): string | number

  • Parameters

    • val: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

    Returns string | number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/signedTwipsMeasureValue.html b/api/functions/signedTwipsMeasureValue.html index 00cae25c69..b2b68de681 100644 --- a/api/functions/signedTwipsMeasureValue.html +++ b/api/functions/signedTwipsMeasureValue.html @@ -1 +1 @@ -signedTwipsMeasureValue | docx

Function signedTwipsMeasureValue

  • signedTwipsMeasureValue(val): number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

  • Parameters

    • val: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

    Returns number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +signedTwipsMeasureValue | docx

Function signedTwipsMeasureValue

  • signedTwipsMeasureValue(val): number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

  • Parameters

    • val: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

    Returns number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/twipsMeasureValue.html b/api/functions/twipsMeasureValue.html index 5127c23731..a44495c21a 100644 --- a/api/functions/twipsMeasureValue.html +++ b/api/functions/twipsMeasureValue.html @@ -1 +1 @@ -twipsMeasureValue | docx

Function twipsMeasureValue

  • twipsMeasureValue(val): number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

  • Parameters

    • val: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

    Returns number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +twipsMeasureValue | docx

Function twipsMeasureValue

  • twipsMeasureValue(val): number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

  • Parameters

    • val: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

    Returns number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/uCharHexNumber.html b/api/functions/uCharHexNumber.html index 77d35d166e..ae09221b5e 100644 --- a/api/functions/uCharHexNumber.html +++ b/api/functions/uCharHexNumber.html @@ -1 +1 @@ -uCharHexNumber | docx

Function uCharHexNumber

  • uCharHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +uCharHexNumber | docx

Function uCharHexNumber

  • uCharHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/uniqueId.html b/api/functions/uniqueId.html index c63f2b79e0..216f087fdc 100644 --- a/api/functions/uniqueId.html +++ b/api/functions/uniqueId.html @@ -1 +1 @@ -uniqueId | docx

Function uniqueId

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +uniqueId | docx

Function uniqueId

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/uniqueNumericIdCreator-1.html b/api/functions/uniqueNumericIdCreator-1.html index cf3cb03838..79d42b16d0 100644 --- a/api/functions/uniqueNumericIdCreator-1.html +++ b/api/functions/uniqueNumericIdCreator-1.html @@ -1 +1 @@ -uniqueNumericIdCreator | docx

Function uniqueNumericIdCreator

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +uniqueNumericIdCreator | docx

Function uniqueNumericIdCreator

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/universalMeasureValue.html b/api/functions/universalMeasureValue.html index 2b25acb38a..a3f5502aa1 100644 --- a/api/functions/universalMeasureValue.html +++ b/api/functions/universalMeasureValue.html @@ -1 +1 @@ -universalMeasureValue | docx

Function universalMeasureValue

  • universalMeasureValue(val): `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

  • Parameters

    • val: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

    Returns `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +universalMeasureValue | docx

Function universalMeasureValue

  • universalMeasureValue(val): `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

  • Parameters

    • val: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

    Returns `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/functions/unsignedDecimalNumber.html b/api/functions/unsignedDecimalNumber.html index 65e64e0a65..0d649d37ee 100644 --- a/api/functions/unsignedDecimalNumber.html +++ b/api/functions/unsignedDecimalNumber.html @@ -1 +1 @@ -unsignedDecimalNumber | docx

Function unsignedDecimalNumber

  • unsignedDecimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +unsignedDecimalNumber | docx

Function unsignedDecimalNumber

  • unsignedDecimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IAlignmentFrameOptions.html b/api/interfaces/IAlignmentFrameOptions.html index ed5ff4ba8b..5379496313 100644 --- a/api/interfaces/IAlignmentFrameOptions.html +++ b/api/interfaces/IAlignmentFrameOptions.html @@ -1,4 +1,4 @@ -IAlignmentFrameOptions | docx

Interface IAlignmentFrameOptions

interface IAlignmentFrameOptions {
    alignment: {
        x: "center" | "left" | "right" | "inside" | "outside";
        y: "bottom" | "center" | "top" | "inside" | "outside";
    };
    anchor: {
        horizontal: "text" | "margin" | "page";
        vertical: "text" | "margin" | "page";
    };
    anchorLock?: boolean;
    dropCap?: "none" | "margin" | "drop";
    height: number;
    lines?: number;
    rule?: "auto" | "atLeast" | "exact";
    space?: {
        horizontal: number;
        vertical: number;
    };
    width: number;
    wrap?: "auto" | "none" | "around" | "notBeside" | "through" | "tight";
}

Hierarchy

  • IBaseFrameOptions
    • IAlignmentFrameOptions

Properties

alignment +IAlignmentFrameOptions | docx

Interface IAlignmentFrameOptions

interface IAlignmentFrameOptions {
    alignment: {
        x: "center" | "left" | "right" | "inside" | "outside";
        y: "bottom" | "center" | "top" | "inside" | "outside";
    };
    anchor: {
        horizontal: "text" | "margin" | "page";
        vertical: "text" | "margin" | "page";
    };
    anchorLock?: boolean;
    dropCap?: "none" | "margin" | "drop";
    height: number;
    lines?: number;
    rule?: "auto" | "atLeast" | "exact";
    space?: {
        horizontal: number;
        vertical: number;
    };
    width: number;
    wrap?: "auto" | "none" | "around" | "notBeside" | "through" | "tight";
}

Hierarchy

  • IBaseFrameOptions
    • IAlignmentFrameOptions

Properties

alignment anchor anchorLock? dropCap? @@ -8,4 +8,4 @@ space? width wrap? -

Properties

Readonly alignment

alignment: {
    x: "center" | "left" | "right" | "inside" | "outside";
    y: "bottom" | "center" | "top" | "inside" | "outside";
}

Type declaration

  • Readonly x: "center" | "left" | "right" | "inside" | "outside"
  • Readonly y: "bottom" | "center" | "top" | "inside" | "outside"

Readonly anchor

anchor: {
    horizontal: "text" | "margin" | "page";
    vertical: "text" | "margin" | "page";
}

Type declaration

  • Readonly horizontal: "text" | "margin" | "page"
  • Readonly vertical: "text" | "margin" | "page"

Optional Readonly anchorLock

anchorLock?: boolean

Optional Readonly dropCap

dropCap?: "none" | "margin" | "drop"

Readonly height

height: number

Optional Readonly lines

lines?: number

Optional Readonly rule

rule?: "auto" | "atLeast" | "exact"

Optional Readonly space

space?: {
    horizontal: number;
    vertical: number;
}

Type declaration

  • Readonly horizontal: number
  • Readonly vertical: number

Readonly width

width: number

Optional Readonly wrap

wrap?: "auto" | "none" | "around" | "notBeside" | "through" | "tight"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly alignment

alignment: {
    x: "center" | "left" | "right" | "inside" | "outside";
    y: "bottom" | "center" | "top" | "inside" | "outside";
}

Type declaration

  • Readonly x: "center" | "left" | "right" | "inside" | "outside"
  • Readonly y: "bottom" | "center" | "top" | "inside" | "outside"

Readonly anchor

anchor: {
    horizontal: "text" | "margin" | "page";
    vertical: "text" | "margin" | "page";
}

Type declaration

  • Readonly horizontal: "text" | "margin" | "page"
  • Readonly vertical: "text" | "margin" | "page"

Optional Readonly anchorLock

anchorLock?: boolean

Optional Readonly dropCap

dropCap?: "none" | "margin" | "drop"

Readonly height

height: number

Optional Readonly lines

lines?: number

Optional Readonly rule

rule?: "auto" | "atLeast" | "exact"

Optional Readonly space

space?: {
    horizontal: number;
    vertical: number;
}

Type declaration

  • Readonly horizontal: number
  • Readonly vertical: number

Readonly width

width: number

Optional Readonly wrap

wrap?: "auto" | "none" | "around" | "notBeside" | "through" | "tight"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IBaseCharacterStyleOptions.html b/api/interfaces/IBaseCharacterStyleOptions.html index 98a7a0a83b..b793cdcff6 100644 --- a/api/interfaces/IBaseCharacterStyleOptions.html +++ b/api/interfaces/IBaseCharacterStyleOptions.html @@ -1,4 +1,4 @@ -IBaseCharacterStyleOptions | docx

Interface IBaseCharacterStyleOptions

interface IBaseCharacterStyleOptions {
    basedOn?: string;
    link?: string;
    name?: string;
    next?: string;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy

Properties

basedOn? +IBaseCharacterStyleOptions | docx

Interface IBaseCharacterStyleOptions

interface IBaseCharacterStyleOptions {
    basedOn?: string;
    link?: string;
    name?: string;
    next?: string;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy

Properties

basedOn? link? name? next? @@ -11,4 +11,4 @@ Note that if the type of the current style must match the type of the style upon which it is based or the basedOn element will be ignored. However, if the current style is a numbering style, then the basedOn element is ignored.

WARNING: You cannot set basedOn to be the same as name. This is akin to inheriting from itself. This creates a cyclic dependency and cause undesirable behavior.

-

Optional Readonly link

link?: string

Optional Readonly name

name?: string

Optional Readonly next

next?: string

Optional Readonly quickFormat

quickFormat?: boolean

Optional Readonly run

run?: IRunStylePropertiesOptions

Optional Readonly semiHidden

semiHidden?: boolean

Optional Readonly uiPriority

uiPriority?: number

Optional Readonly unhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional Readonly link

link?: string

Optional Readonly name

name?: string

Optional Readonly next

next?: string

Optional Readonly quickFormat

quickFormat?: boolean

Optional Readonly run

run?: IRunStylePropertiesOptions

Optional Readonly semiHidden

semiHidden?: boolean

Optional Readonly uiPriority

uiPriority?: number

Optional Readonly unhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IBaseParagraphStyleOptions.html b/api/interfaces/IBaseParagraphStyleOptions.html index e338c2a467..2b5fd5066f 100644 --- a/api/interfaces/IBaseParagraphStyleOptions.html +++ b/api/interfaces/IBaseParagraphStyleOptions.html @@ -1,4 +1,4 @@ -IBaseParagraphStyleOptions | docx

Interface IBaseParagraphStyleOptions

interface IBaseParagraphStyleOptions {
    basedOn?: string;
    link?: string;
    name?: string;
    next?: string;
    paragraph?: IParagraphStylePropertiesOptions;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy

Properties

basedOn? +IBaseParagraphStyleOptions | docx

Interface IBaseParagraphStyleOptions

interface IBaseParagraphStyleOptions {
    basedOn?: string;
    link?: string;
    name?: string;
    next?: string;
    paragraph?: IParagraphStylePropertiesOptions;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy

Properties

basedOn? link? name? next? @@ -12,4 +12,4 @@ Note that if the type of the current style must match the type of the style upon which it is based or the basedOn element will be ignored. However, if the current style is a numbering style, then the basedOn element is ignored.

WARNING: You cannot set basedOn to be the same as name. This is akin to inheriting from itself. This creates a cyclic dependency and cause undesirable behavior.

-

Optional Readonly link

link?: string

Optional Readonly name

name?: string

Optional Readonly next

next?: string

Optional Readonly paragraph

paragraph?: IParagraphStylePropertiesOptions

Optional Readonly quickFormat

quickFormat?: boolean

Optional Readonly run

run?: IRunStylePropertiesOptions

Optional Readonly semiHidden

semiHidden?: boolean

Optional Readonly uiPriority

uiPriority?: number

Optional Readonly unhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional Readonly link

link?: string

Optional Readonly name

name?: string

Optional Readonly next

next?: string

Optional Readonly paragraph

paragraph?: IParagraphStylePropertiesOptions

Optional Readonly quickFormat

quickFormat?: boolean

Optional Readonly run

run?: IRunStylePropertiesOptions

Optional Readonly semiHidden

semiHidden?: boolean

Optional Readonly uiPriority

uiPriority?: number

Optional Readonly unhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IBorderOptions.html b/api/interfaces/IBorderOptions.html index efa9676eca..ca111f56ae 100644 --- a/api/interfaces/IBorderOptions.html +++ b/api/interfaces/IBorderOptions.html @@ -1,8 +1,8 @@ -IBorderOptions | docx

Interface IBorderOptions

interface IBorderOptions {
    color?: string;
    size?: number;
    space?: number;
    style: "nil" | "single" | "dashDotStroked" | "dashed" | "dashSmallGap" | "dotDash" | "dotDotDash" | "dotted" | "double" | "doubleWave" | "inset" | "none" | "outset" | "thick" | "thickThinLargeGap" | "thickThinMediumGap" | "thickThinSmallGap" | "thinThickLargeGap" | "thinThickMediumGap" | "thinThickSmallGap" | "thinThickThinLargeGap" | "thinThickThinMediumGap" | "thinThickThinSmallGap" | "threeDEmboss" | "threeDEngrave" | "triple" | "wave";
}

Properties

color? +IBorderOptions | docx

Interface IBorderOptions

interface IBorderOptions {
    color?: string;
    size?: number;
    space?: number;
    style: "nil" | "single" | "dashDotStroked" | "dashed" | "dashSmallGap" | "dotDash" | "dotDotDash" | "dotted" | "double" | "doubleWave" | "inset" | "none" | "outset" | "thick" | "thickThinLargeGap" | "thickThinMediumGap" | "thickThinSmallGap" | "thinThickLargeGap" | "thinThickMediumGap" | "thinThickSmallGap" | "thinThickThinLargeGap" | "thinThickThinMediumGap" | "thinThickThinSmallGap" | "threeDEmboss" | "threeDEngrave" | "triple" | "wave";
}

Properties

color? size? space? style

Properties

Optional Readonly color

color?: string

Border color, in hex (eg 'FF00AA')

-

Optional Readonly size

size?: number

Size of the border in 1/8 pt

-

Optional Readonly space

space?: number

Spacing offset. Values are specified in pt

-

Readonly style

style: "nil" | "single" | "dashDotStroked" | "dashed" | "dashSmallGap" | "dotDash" | "dotDotDash" | "dotted" | "double" | "doubleWave" | "inset" | "none" | "outset" | "thick" | "thickThinLargeGap" | "thickThinMediumGap" | "thickThinSmallGap" | "thinThickLargeGap" | "thinThickMediumGap" | "thinThickSmallGap" | "thinThickThinLargeGap" | "thinThickThinMediumGap" | "thinThickThinSmallGap" | "threeDEmboss" | "threeDEngrave" | "triple" | "wave"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional Readonly size

size?: number

Size of the border in 1/8 pt

+

Optional Readonly space

space?: number

Spacing offset. Values are specified in pt

+

Readonly style

style: "nil" | "single" | "dashDotStroked" | "dashed" | "dashSmallGap" | "dotDash" | "dotDotDash" | "dotted" | "double" | "doubleWave" | "inset" | "none" | "outset" | "thick" | "thickThinLargeGap" | "thickThinMediumGap" | "thickThinSmallGap" | "thinThickLargeGap" | "thinThickMediumGap" | "thinThickSmallGap" | "thinThickThinLargeGap" | "thinThickThinMediumGap" | "thinThickThinSmallGap" | "threeDEmboss" | "threeDEngrave" | "triple" | "wave"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IBordersOptions.html b/api/interfaces/IBordersOptions.html index 32798bb468..260378e9d7 100644 --- a/api/interfaces/IBordersOptions.html +++ b/api/interfaces/IBordersOptions.html @@ -1,5 +1,5 @@ -IBordersOptions | docx

Interface IBordersOptions

interface IBordersOptions {
    bottom?: IBorderOptions;
    left?: IBorderOptions;
    right?: IBorderOptions;
    top?: IBorderOptions;
}

Properties

bottom? +IBordersOptions | docx

Interface IBordersOptions

interface IBordersOptions {
    bottom?: IBorderOptions;
    left?: IBorderOptions;
    right?: IBorderOptions;
    top?: IBorderOptions;
}

Properties

bottom? left? right? top? -

Properties

Optional Readonly bottom

bottom?: IBorderOptions

Optional Readonly left

left?: IBorderOptions

Optional Readonly right

right?: IBorderOptions

Optional Readonly top

top?: IBorderOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly bottom

bottom?: IBorderOptions

Optional Readonly left

left?: IBorderOptions

Optional Readonly right

right?: IBorderOptions

Optional Readonly top

top?: IBorderOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ICharacterStyleOptions.html b/api/interfaces/ICharacterStyleOptions.html index fdaf811700..a34a2001f9 100644 --- a/api/interfaces/ICharacterStyleOptions.html +++ b/api/interfaces/ICharacterStyleOptions.html @@ -1,4 +1,4 @@ -ICharacterStyleOptions | docx

Interface ICharacterStyleOptions

interface ICharacterStyleOptions {
    basedOn?: string;
    id: string;
    link?: string;
    name?: string;
    next?: string;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy

Properties

basedOn? +ICharacterStyleOptions | docx

Interface ICharacterStyleOptions

interface ICharacterStyleOptions {
    basedOn?: string;
    id: string;
    link?: string;
    name?: string;
    next?: string;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy

Properties

basedOn? id link? name? @@ -12,4 +12,4 @@ Note that if the type of the current style must match the type of the style upon which it is based or the basedOn element will be ignored. However, if the current style is a numbering style, then the basedOn element is ignored.

WARNING: You cannot set basedOn to be the same as name. This is akin to inheriting from itself. This creates a cyclic dependency and cause undesirable behavior.

-

Readonly id

id: string

Optional Readonly link

link?: string

Optional Readonly name

name?: string

Optional Readonly next

next?: string

Optional Readonly quickFormat

quickFormat?: boolean

Optional Readonly run

run?: IRunStylePropertiesOptions

Optional Readonly semiHidden

semiHidden?: boolean

Optional Readonly uiPriority

uiPriority?: number

Optional Readonly unhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Readonly id

id: string

Optional Readonly link

link?: string

Optional Readonly name

name?: string

Optional Readonly next

next?: string

Optional Readonly quickFormat

quickFormat?: boolean

Optional Readonly run

run?: IRunStylePropertiesOptions

Optional Readonly semiHidden

semiHidden?: boolean

Optional Readonly uiPriority

uiPriority?: number

Optional Readonly unhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ICheckboxSymbolOptions.html b/api/interfaces/ICheckboxSymbolOptions.html index 78a22be769..84ba871a93 100644 --- a/api/interfaces/ICheckboxSymbolOptions.html +++ b/api/interfaces/ICheckboxSymbolOptions.html @@ -1,5 +1,5 @@ -ICheckboxSymbolOptions | docx

Interface ICheckboxSymbolOptions

interface ICheckboxSymbolOptions {
    alias?: string;
    checked?: boolean;
    checkedState?: ICheckboxSymbolProperties;
    uncheckedState?: ICheckboxSymbolProperties;
}

Properties

alias? +ICheckboxSymbolOptions | docx

Interface ICheckboxSymbolOptions

interface ICheckboxSymbolOptions {
    alias?: string;
    checked?: boolean;
    checkedState?: ICheckboxSymbolProperties;
    uncheckedState?: ICheckboxSymbolProperties;
}

Properties

alias? checked? checkedState? uncheckedState? -

Properties

Optional Readonly alias

alias?: string

Optional Readonly checked

checked?: boolean

Optional Readonly checkedState

checkedState?: ICheckboxSymbolProperties

Optional Readonly uncheckedState

uncheckedState?: ICheckboxSymbolProperties

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly alias

alias?: string

Optional Readonly checked

checked?: boolean

Optional Readonly checkedState

checkedState?: ICheckboxSymbolProperties

Optional Readonly uncheckedState

uncheckedState?: ICheckboxSymbolProperties

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ICheckboxSymbolProperties.html b/api/interfaces/ICheckboxSymbolProperties.html index b1aea6004f..9af0de7b33 100644 --- a/api/interfaces/ICheckboxSymbolProperties.html +++ b/api/interfaces/ICheckboxSymbolProperties.html @@ -1,3 +1,3 @@ -ICheckboxSymbolProperties | docx

Interface ICheckboxSymbolProperties

interface ICheckboxSymbolProperties {
    font?: string;
    value?: string;
}

Properties

font? +ICheckboxSymbolProperties | docx

Interface ICheckboxSymbolProperties

interface ICheckboxSymbolProperties {
    font?: string;
    value?: string;
}

Properties

font? value? -

Properties

Optional Readonly font

font?: string

Optional Readonly value

value?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly font

font?: string

Optional Readonly value

value?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ICommentOptions.html b/api/interfaces/ICommentOptions.html index acbfee18f4..dfe8968f54 100644 --- a/api/interfaces/ICommentOptions.html +++ b/api/interfaces/ICommentOptions.html @@ -1,6 +1,6 @@ -ICommentOptions | docx

Interface ICommentOptions

interface ICommentOptions {
    author?: string;
    children: readonly FileChild[];
    date?: Date;
    id: number;
    initials?: string;
}

Properties

author? +ICommentOptions | docx

Interface ICommentOptions

interface ICommentOptions {
    author?: string;
    children: readonly FileChild[];
    date?: Date;
    id: number;
    initials?: string;
}

Properties

author? children date? id initials? -

Properties

Optional Readonly author

author?: string

Readonly children

children: readonly FileChild[]

Optional Readonly date

date?: Date

Readonly id

id: number

Optional Readonly initials

initials?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly author

author?: string

Readonly children

children: readonly FileChild[]

Optional Readonly date

date?: Date

Readonly id

id: number

Optional Readonly initials

initials?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ICommentsOptions.html b/api/interfaces/ICommentsOptions.html index f7f9908327..71bbf63dbe 100644 --- a/api/interfaces/ICommentsOptions.html +++ b/api/interfaces/ICommentsOptions.html @@ -1,2 +1,2 @@ -ICommentsOptions | docx

Interface ICommentsOptions

interface ICommentsOptions {
    children: readonly ICommentOptions[];
}

Properties

children -

Properties

Readonly children

children: readonly ICommentOptions[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +ICommentsOptions | docx

Interface ICommentsOptions

interface ICommentsOptions {
    children: readonly ICommentOptions[];
}

Properties

children +

Properties

Readonly children

children: readonly ICommentOptions[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IConcreteNumberingOptions.html b/api/interfaces/IConcreteNumberingOptions.html index 671f1a1572..2d9825f56a 100644 --- a/api/interfaces/IConcreteNumberingOptions.html +++ b/api/interfaces/IConcreteNumberingOptions.html @@ -1,6 +1,6 @@ -IConcreteNumberingOptions | docx

Interface IConcreteNumberingOptions

interface IConcreteNumberingOptions {
    abstractNumId: number;
    instance: number;
    numId: number;
    overrideLevels?: readonly IOverrideLevel[];
    reference: string;
}

Properties

abstractNumId +IConcreteNumberingOptions | docx

Interface IConcreteNumberingOptions

interface IConcreteNumberingOptions {
    abstractNumId: number;
    instance: number;
    numId: number;
    overrideLevels?: readonly IOverrideLevel[];
    reference: string;
}

Properties

abstractNumId instance numId overrideLevels? reference -

Properties

Readonly abstractNumId

abstractNumId: number

Readonly instance

instance: number

Readonly numId

numId: number

Optional Readonly overrideLevels

overrideLevels?: readonly IOverrideLevel[]

Readonly reference

reference: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly abstractNumId

abstractNumId: number

Readonly instance

instance: number

Readonly numId

numId: number

Optional Readonly overrideLevels

overrideLevels?: readonly IOverrideLevel[]

Readonly reference

reference: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IContext.html b/api/interfaces/IContext.html index a6ac707bef..21caa2255c 100644 --- a/api/interfaces/IContext.html +++ b/api/interfaces/IContext.html @@ -1,4 +1,4 @@ -IContext | docx

Interface IContext

interface IContext {
    file: Document;
    stack: IXmlableObject[];
    viewWrapper: IViewWrapper;
}

Properties

file +IContext | docx

Interface IContext

interface IContext {
    file: Document;
    stack: IXmlableObject[];
    viewWrapper: IViewWrapper;
}

Properties

file stack viewWrapper -

Properties

Readonly file

file: Document

Readonly stack

stack: IXmlableObject[]

Readonly viewWrapper

viewWrapper: IViewWrapper

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly file

file: Document

Readonly stack

stack: IXmlableObject[]

Readonly viewWrapper

viewWrapper: IViewWrapper

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IDistance.html b/api/interfaces/IDistance.html index 26bd0f3941..77dc45024e 100644 --- a/api/interfaces/IDistance.html +++ b/api/interfaces/IDistance.html @@ -1,5 +1,5 @@ -IDistance | docx

Interface IDistance

interface IDistance {
    distB?: number;
    distL?: number;
    distR?: number;
    distT?: number;
}

Properties

distB? +IDistance | docx

Interface IDistance

interface IDistance {
    distB?: number;
    distL?: number;
    distR?: number;
    distT?: number;
}

Properties

distB? distL? distR? distT? -

Properties

Optional Readonly distB

distB?: number

Optional Readonly distL

distL?: number

Optional Readonly distR

distR?: number

Optional Readonly distT

distT?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly distB

distB?: number

Optional Readonly distL

distL?: number

Optional Readonly distR

distR?: number

Optional Readonly distT

distT?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IDocGridAttributesProperties.html b/api/interfaces/IDocGridAttributesProperties.html index 0cf8df0fde..117692c3d0 100644 --- a/api/interfaces/IDocGridAttributesProperties.html +++ b/api/interfaces/IDocGridAttributesProperties.html @@ -1,4 +1,4 @@ -IDocGridAttributesProperties | docx

Interface IDocGridAttributesProperties

interface IDocGridAttributesProperties {
    charSpace?: number;
    linePitch?: number;
    type?: "default" | "lines" | "linesAndChars" | "snapToChars";
}

Properties

charSpace? +IDocGridAttributesProperties | docx

Interface IDocGridAttributesProperties

interface IDocGridAttributesProperties {
    charSpace?: number;
    linePitch?: number;
    type?: "default" | "lines" | "linesAndChars" | "snapToChars";
}

Properties

charSpace? linePitch? type? -

Properties

Optional Readonly charSpace

charSpace?: number

Optional Readonly linePitch

linePitch?: number

Optional Readonly type

type?: "default" | "lines" | "linesAndChars" | "snapToChars"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly charSpace

charSpace?: number

Optional Readonly linePitch

linePitch?: number

Optional Readonly type

type?: "default" | "lines" | "linesAndChars" | "snapToChars"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IDocumentAttributesProperties.html b/api/interfaces/IDocumentAttributesProperties.html index d74f185276..4354b3de31 100644 --- a/api/interfaces/IDocumentAttributesProperties.html +++ b/api/interfaces/IDocumentAttributesProperties.html @@ -1,4 +1,4 @@ -IDocumentAttributesProperties | docx

Interface IDocumentAttributesProperties

interface IDocumentAttributesProperties {
    Ignorable?: string;
    aink?: string;
    am3d?: string;
    cp?: string;
    cx?: string;
    cx1?: string;
    cx2?: string;
    cx3?: string;
    cx4?: string;
    cx5?: string;
    cx6?: string;
    cx7?: string;
    cx8?: string;
    dc?: string;
    dcmitype?: string;
    dcterms?: string;
    m?: string;
    mc?: string;
    o?: string;
    r?: string;
    type?: string;
    v?: string;
    w?: string;
    w10?: string;
    w14?: string;
    w15?: string;
    w16?: string;
    w16cex?: string;
    w16cid?: string;
    w16sdtdh?: string;
    w16se?: string;
    wne?: string;
    wp?: string;
    wp14?: string;
    wpc?: string;
    wpg?: string;
    wpi?: string;
    wps?: string;
    xsi?: string;
}

Properties

Ignorable? +IDocumentAttributesProperties | docx

Interface IDocumentAttributesProperties

interface IDocumentAttributesProperties {
    Ignorable?: string;
    aink?: string;
    am3d?: string;
    cp?: string;
    cx?: string;
    cx1?: string;
    cx2?: string;
    cx3?: string;
    cx4?: string;
    cx5?: string;
    cx6?: string;
    cx7?: string;
    cx8?: string;
    dc?: string;
    dcmitype?: string;
    dcterms?: string;
    m?: string;
    mc?: string;
    o?: string;
    r?: string;
    type?: string;
    v?: string;
    w?: string;
    w10?: string;
    w14?: string;
    w15?: string;
    w16?: string;
    w16cex?: string;
    w16cid?: string;
    w16sdtdh?: string;
    w16se?: string;
    wne?: string;
    wp?: string;
    wp14?: string;
    wpc?: string;
    wpg?: string;
    wpi?: string;
    wps?: string;
    xsi?: string;
}

Properties

Ignorable? aink? am3d? cp? @@ -37,4 +37,4 @@ wpi? wps? xsi? -

Properties

Optional Readonly Ignorable

Ignorable?: string

Optional Readonly aink

aink?: string

Optional Readonly am3d

am3d?: string

Optional Readonly cp

cp?: string

Optional Readonly cx

cx?: string

Optional Readonly cx1

cx1?: string

Optional Readonly cx2

cx2?: string

Optional Readonly cx3

cx3?: string

Optional Readonly cx4

cx4?: string

Optional Readonly cx5

cx5?: string

Optional Readonly cx6

cx6?: string

Optional Readonly cx7

cx7?: string

Optional Readonly cx8

cx8?: string

Optional Readonly dc

dc?: string

Optional Readonly dcmitype

dcmitype?: string

Optional Readonly dcterms

dcterms?: string

Optional Readonly m

m?: string

Optional Readonly mc

mc?: string

Optional Readonly o

o?: string

Optional Readonly r

r?: string

Optional Readonly type

type?: string

Optional Readonly v

v?: string

Optional Readonly w

w?: string

Optional Readonly w10

w10?: string

Optional Readonly w14

w14?: string

Optional Readonly w15

w15?: string

Optional Readonly w16

w16?: string

Optional Readonly w16cex

w16cex?: string

Optional Readonly w16cid

w16cid?: string

Optional Readonly w16sdtdh

w16sdtdh?: string

Optional Readonly w16se

w16se?: string

Optional Readonly wne

wne?: string

Optional Readonly wp

wp?: string

Optional Readonly wp14

wp14?: string

Optional Readonly wpc

wpc?: string

Optional Readonly wpg

wpg?: string

Optional Readonly wpi

wpi?: string

Optional Readonly wps

wps?: string

Optional Readonly xsi

xsi?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly Ignorable

Ignorable?: string

Optional Readonly aink

aink?: string

Optional Readonly am3d

am3d?: string

Optional Readonly cp

cp?: string

Optional Readonly cx

cx?: string

Optional Readonly cx1

cx1?: string

Optional Readonly cx2

cx2?: string

Optional Readonly cx3

cx3?: string

Optional Readonly cx4

cx4?: string

Optional Readonly cx5

cx5?: string

Optional Readonly cx6

cx6?: string

Optional Readonly cx7

cx7?: string

Optional Readonly cx8

cx8?: string

Optional Readonly dc

dc?: string

Optional Readonly dcmitype

dcmitype?: string

Optional Readonly dcterms

dcterms?: string

Optional Readonly m

m?: string

Optional Readonly mc

mc?: string

Optional Readonly o

o?: string

Optional Readonly r

r?: string

Optional Readonly type

type?: string

Optional Readonly v

v?: string

Optional Readonly w

w?: string

Optional Readonly w10

w10?: string

Optional Readonly w14

w14?: string

Optional Readonly w15

w15?: string

Optional Readonly w16

w16?: string

Optional Readonly w16cex

w16cex?: string

Optional Readonly w16cid

w16cid?: string

Optional Readonly w16sdtdh

w16sdtdh?: string

Optional Readonly w16se

w16se?: string

Optional Readonly wne

wne?: string

Optional Readonly wp

wp?: string

Optional Readonly wp14

wp14?: string

Optional Readonly wpc

wpc?: string

Optional Readonly wpg

wpg?: string

Optional Readonly wpi

wpi?: string

Optional Readonly wps

wps?: string

Optional Readonly xsi

xsi?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IDocumentBackgroundOptions.html b/api/interfaces/IDocumentBackgroundOptions.html index e7ce010202..dd42d9f677 100644 --- a/api/interfaces/IDocumentBackgroundOptions.html +++ b/api/interfaces/IDocumentBackgroundOptions.html @@ -1,5 +1,5 @@ -IDocumentBackgroundOptions | docx

Interface IDocumentBackgroundOptions

interface IDocumentBackgroundOptions {
    color?: string;
    themeColor?: string;
    themeShade?: string;
    themeTint?: string;
}

Properties

color? +IDocumentBackgroundOptions | docx

Interface IDocumentBackgroundOptions

interface IDocumentBackgroundOptions {
    color?: string;
    themeColor?: string;
    themeShade?: string;
    themeTint?: string;
}

Properties

color? themeColor? themeShade? themeTint? -

Properties

Optional Readonly color

color?: string

Optional Readonly themeColor

themeColor?: string

Optional Readonly themeShade

themeShade?: string

Optional Readonly themeTint

themeTint?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly color

color?: string

Optional Readonly themeColor

themeColor?: string

Optional Readonly themeShade

themeShade?: string

Optional Readonly themeTint

themeTint?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IDocumentDefaultsOptions.html b/api/interfaces/IDocumentDefaultsOptions.html index b1f6a668f7..fd20f6c1b0 100644 --- a/api/interfaces/IDocumentDefaultsOptions.html +++ b/api/interfaces/IDocumentDefaultsOptions.html @@ -1,3 +1,3 @@ -IDocumentDefaultsOptions | docx

Interface IDocumentDefaultsOptions

interface IDocumentDefaultsOptions {
    paragraph?: IParagraphStylePropertiesOptions;
    run?: IRunStylePropertiesOptions;
}

Properties

paragraph? +IDocumentDefaultsOptions | docx

Interface IDocumentDefaultsOptions

interface IDocumentDefaultsOptions {
    paragraph?: IParagraphStylePropertiesOptions;
    run?: IRunStylePropertiesOptions;
}

Properties

paragraph? run? -

Properties

Optional Readonly paragraph

paragraph?: IParagraphStylePropertiesOptions

Optional Readonly run

run?: IRunStylePropertiesOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly paragraph

paragraph?: IParagraphStylePropertiesOptions

Optional Readonly run

run?: IRunStylePropertiesOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IDocumentFooter.html b/api/interfaces/IDocumentFooter.html index 2ac49c1824..9aa4f665d6 100644 --- a/api/interfaces/IDocumentFooter.html +++ b/api/interfaces/IDocumentFooter.html @@ -1,3 +1,3 @@ -IDocumentFooter | docx

Interface IDocumentFooter

interface IDocumentFooter {
    footer: FooterWrapper;
    type: "default" | "first" | "even";
}

Properties

footer +IDocumentFooter | docx

Interface IDocumentFooter

interface IDocumentFooter {
    footer: FooterWrapper;
    type: "default" | "first" | "even";
}

Properties

footer type -

Properties

Readonly footer

footer: FooterWrapper

Readonly type

type: "default" | "first" | "even"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly footer

footer: FooterWrapper

Readonly type

type: "default" | "first" | "even"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IDocumentHeader.html b/api/interfaces/IDocumentHeader.html index 195bed94f8..d93a5411c8 100644 --- a/api/interfaces/IDocumentHeader.html +++ b/api/interfaces/IDocumentHeader.html @@ -1,3 +1,3 @@ -IDocumentHeader | docx

Interface IDocumentHeader

interface IDocumentHeader {
    header: HeaderWrapper;
    type: "default" | "first" | "even";
}

Properties

header +IDocumentHeader | docx

Interface IDocumentHeader

interface IDocumentHeader {
    header: HeaderWrapper;
    type: "default" | "first" | "even";
}

Properties

header type -

Properties

Readonly header

header: HeaderWrapper

Readonly type

type: "default" | "first" | "even"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly header

header: HeaderWrapper

Readonly type

type: "default" | "first" | "even"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IDocumentOptions.html b/api/interfaces/IDocumentOptions.html index 86d525d794..c565e625f9 100644 --- a/api/interfaces/IDocumentOptions.html +++ b/api/interfaces/IDocumentOptions.html @@ -1,2 +1,2 @@ -IDocumentOptions | docx

Interface IDocumentOptions

interface IDocumentOptions {
    background?: IDocumentBackgroundOptions;
}

Properties

background? -

Properties

Optional Readonly background

background?: IDocumentBackgroundOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +IDocumentOptions | docx

Interface IDocumentOptions

interface IDocumentOptions {
    background?: IDocumentBackgroundOptions;
}

Properties

background? +

Properties

Optional Readonly background

background?: IDocumentBackgroundOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IDrawingOptions.html b/api/interfaces/IDrawingOptions.html index f3740a7a1b..1b8e8dda7d 100644 --- a/api/interfaces/IDrawingOptions.html +++ b/api/interfaces/IDrawingOptions.html @@ -1,3 +1,3 @@ -IDrawingOptions | docx

Interface IDrawingOptions

interface IDrawingOptions {
    docProperties?: DocPropertiesOptions;
    floating?: IFloating;
}

Properties

docProperties? +IDrawingOptions | docx

Interface IDrawingOptions

interface IDrawingOptions {
    docProperties?: DocPropertiesOptions;
    floating?: IFloating;
}

Properties

docProperties? floating? -

Properties

Optional Readonly docProperties

docProperties?: DocPropertiesOptions

Optional Readonly floating

floating?: IFloating

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly docProperties

docProperties?: DocPropertiesOptions

Optional Readonly floating

floating?: IFloating

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IFloating.html b/api/interfaces/IFloating.html index 270a506e42..8977e7b83a 100644 --- a/api/interfaces/IFloating.html +++ b/api/interfaces/IFloating.html @@ -1,4 +1,4 @@ -IFloating | docx

Interface IFloating

interface IFloating {
    allowOverlap?: boolean;
    behindDocument?: boolean;
    horizontalPosition: IHorizontalPositionOptions;
    layoutInCell?: boolean;
    lockAnchor?: boolean;
    margins?: IMargins;
    verticalPosition: IVerticalPositionOptions;
    wrap?: ITextWrapping;
    zIndex?: number;
}

Properties

allowOverlap? +IFloating | docx

Interface IFloating

interface IFloating {
    allowOverlap?: boolean;
    behindDocument?: boolean;
    horizontalPosition: IHorizontalPositionOptions;
    layoutInCell?: boolean;
    lockAnchor?: boolean;
    margins?: IMargins;
    verticalPosition: IVerticalPositionOptions;
    wrap?: ITextWrapping;
    zIndex?: number;
}

Properties

allowOverlap? behindDocument? horizontalPosition layoutInCell? @@ -7,4 +7,4 @@ verticalPosition wrap? zIndex? -

Properties

Optional Readonly allowOverlap

allowOverlap?: boolean

Optional Readonly behindDocument

behindDocument?: boolean

Readonly horizontalPosition

horizontalPosition: IHorizontalPositionOptions

Optional Readonly layoutInCell

layoutInCell?: boolean

Optional Readonly lockAnchor

lockAnchor?: boolean

Optional Readonly margins

margins?: IMargins

Readonly verticalPosition

verticalPosition: IVerticalPositionOptions

Optional Readonly wrap

wrap?: ITextWrapping

Optional Readonly zIndex

zIndex?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly allowOverlap

allowOverlap?: boolean

Optional Readonly behindDocument

behindDocument?: boolean

Readonly horizontalPosition

horizontalPosition: IHorizontalPositionOptions

Optional Readonly layoutInCell

layoutInCell?: boolean

Optional Readonly lockAnchor

lockAnchor?: boolean

Optional Readonly margins

margins?: IMargins

Readonly verticalPosition

verticalPosition: IVerticalPositionOptions

Optional Readonly wrap

wrap?: ITextWrapping

Optional Readonly zIndex

zIndex?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IFontAttributesProperties.html b/api/interfaces/IFontAttributesProperties.html index 24bd53fe02..bfdb03c4dd 100644 --- a/api/interfaces/IFontAttributesProperties.html +++ b/api/interfaces/IFontAttributesProperties.html @@ -1,6 +1,6 @@ -IFontAttributesProperties | docx

Interface IFontAttributesProperties

interface IFontAttributesProperties {
    ascii?: string;
    cs?: string;
    eastAsia?: string;
    hAnsi?: string;
    hint?: string;
}

Properties

ascii? +IFontAttributesProperties | docx

Interface IFontAttributesProperties

interface IFontAttributesProperties {
    ascii?: string;
    cs?: string;
    eastAsia?: string;
    hAnsi?: string;
    hint?: string;
}

Properties

ascii? cs? eastAsia? hAnsi? hint? -

Properties

Optional Readonly ascii

ascii?: string

Optional Readonly cs

cs?: string

Optional Readonly eastAsia

eastAsia?: string

Optional Readonly hAnsi

hAnsi?: string

Optional Readonly hint

hint?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly ascii

ascii?: string

Optional Readonly cs

cs?: string

Optional Readonly eastAsia

eastAsia?: string

Optional Readonly hAnsi

hAnsi?: string

Optional Readonly hint

hint?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IHeaderFooterGroup.html b/api/interfaces/IHeaderFooterGroup.html index fdc1de11a0..668e9ebb63 100644 --- a/api/interfaces/IHeaderFooterGroup.html +++ b/api/interfaces/IHeaderFooterGroup.html @@ -1,4 +1,4 @@ -IHeaderFooterGroup | docx

Interface IHeaderFooterGroup<T>

interface IHeaderFooterGroup {
    default?: T;
    even?: T;
    first?: T;
}

Type Parameters

  • T

Properties

default? +IHeaderFooterGroup | docx

Interface IHeaderFooterGroup<T>

interface IHeaderFooterGroup {
    default?: T;
    even?: T;
    first?: T;
}

Type Parameters

  • T

Properties

default? even? first? -

Properties

Optional Readonly default

default?: T

Optional Readonly even

even?: T

Optional Readonly first

first?: T

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly default

default?: T

Optional Readonly even

even?: T

Optional Readonly first

first?: T

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IHeaderFooterOptions.html b/api/interfaces/IHeaderFooterOptions.html index bec0349b74..6c7f49774c 100644 --- a/api/interfaces/IHeaderFooterOptions.html +++ b/api/interfaces/IHeaderFooterOptions.html @@ -1,3 +1,3 @@ -IHeaderFooterOptions | docx

Interface IHeaderFooterOptions

interface IHeaderFooterOptions {
    id?: number;
    type?: "default" | "first" | "even";
}

Properties

id? +IHeaderFooterOptions | docx

Interface IHeaderFooterOptions

interface IHeaderFooterOptions {
    id?: number;
    type?: "default" | "first" | "even";
}

Properties

id? type? -

Properties

Optional Readonly id

id?: number

Optional Readonly type

type?: "default" | "first" | "even"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly id

id?: number

Optional Readonly type

type?: "default" | "first" | "even"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IHeaderOptions.html b/api/interfaces/IHeaderOptions.html index 1f8792f05f..0c2456fbed 100644 --- a/api/interfaces/IHeaderOptions.html +++ b/api/interfaces/IHeaderOptions.html @@ -1,2 +1,2 @@ -IHeaderOptions | docx

Interface IHeaderOptions

interface IHeaderOptions {
    children: readonly (Paragraph | Table)[];
}

Properties

children -

Properties

Readonly children

children: readonly (Paragraph | Table)[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +IHeaderOptions | docx

Interface IHeaderOptions

interface IHeaderOptions {
    children: readonly (Paragraph | Table)[];
}

Properties

children +

Properties

Readonly children

children: readonly (Paragraph | Table)[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IHorizontalPositionOptions.html b/api/interfaces/IHorizontalPositionOptions.html index d91897c6a8..5ed0c2fc08 100644 --- a/api/interfaces/IHorizontalPositionOptions.html +++ b/api/interfaces/IHorizontalPositionOptions.html @@ -1,4 +1,4 @@ -IHorizontalPositionOptions | docx

Interface IHorizontalPositionOptions

interface IHorizontalPositionOptions {
    align?: "center" | "left" | "right" | "inside" | "outside";
    offset?: number;
    relative?: "margin" | "page" | "character" | "column" | "insideMargin" | "leftMargin" | "outsideMargin" | "rightMargin";
}

Properties

align? +IHorizontalPositionOptions | docx

Interface IHorizontalPositionOptions

interface IHorizontalPositionOptions {
    align?: "center" | "left" | "right" | "inside" | "outside";
    offset?: number;
    relative?: "margin" | "page" | "character" | "column" | "insideMargin" | "leftMargin" | "outsideMargin" | "rightMargin";
}

Properties

align? offset? relative? -

Properties

Optional Readonly align

align?: "center" | "left" | "right" | "inside" | "outside"

Optional Readonly offset

offset?: number

Optional Readonly relative

relative?: "margin" | "page" | "character" | "column" | "insideMargin" | "leftMargin" | "outsideMargin" | "rightMargin"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly align

align?: "center" | "left" | "right" | "inside" | "outside"

Optional Readonly offset

offset?: number

Optional Readonly relative

relative?: "margin" | "page" | "character" | "column" | "insideMargin" | "leftMargin" | "outsideMargin" | "rightMargin"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IImageOptions.html b/api/interfaces/IImageOptions.html index 2fed1838f7..f51491335f 100644 --- a/api/interfaces/IImageOptions.html +++ b/api/interfaces/IImageOptions.html @@ -1,5 +1,5 @@ -IImageOptions | docx

Interface IImageOptions

interface IImageOptions {
    altText?: DocPropertiesOptions;
    data: string | Buffer | Uint8Array | ArrayBuffer;
    floating?: IFloating;
    transformation: IMediaTransformation;
}

Properties

altText? +IImageOptions | docx

Interface IImageOptions

interface IImageOptions {
    altText?: DocPropertiesOptions;
    data: string | Buffer | Uint8Array | ArrayBuffer;
    floating?: IFloating;
    transformation: IMediaTransformation;
}

Properties

altText? data floating? transformation -

Properties

Optional Readonly altText

altText?: DocPropertiesOptions

Readonly data

data: string | Buffer | Uint8Array | ArrayBuffer

Optional Readonly floating

floating?: IFloating

Readonly transformation

transformation: IMediaTransformation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly altText

altText?: DocPropertiesOptions

Readonly data

data: string | Buffer | Uint8Array | ArrayBuffer

Optional Readonly floating

floating?: IFloating

Readonly transformation

transformation: IMediaTransformation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IIndentAttributesProperties.html b/api/interfaces/IIndentAttributesProperties.html index de8f78252b..0a7ffd1f17 100644 --- a/api/interfaces/IIndentAttributesProperties.html +++ b/api/interfaces/IIndentAttributesProperties.html @@ -1,7 +1,7 @@ -IIndentAttributesProperties | docx

Interface IIndentAttributesProperties

interface IIndentAttributesProperties {
    end?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    firstLine?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    hanging?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    left?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    right?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    start?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
}

Properties

end? +IIndentAttributesProperties | docx

Interface IIndentAttributesProperties

interface IIndentAttributesProperties {
    end?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    firstLine?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    hanging?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    left?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    right?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    start?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
}

Properties

end? firstLine? hanging? left? right? start? -

Properties

Optional Readonly end

end?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly firstLine

firstLine?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly hanging

hanging?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly left

left?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly right

right?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly start

start?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly end

end?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly firstLine

firstLine?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly hanging

hanging?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly left

left?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly right

right?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly start

start?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ILevelParagraphStylePropertiesOptions.html b/api/interfaces/ILevelParagraphStylePropertiesOptions.html index 3fa5add894..7a506e7945 100644 --- a/api/interfaces/ILevelParagraphStylePropertiesOptions.html +++ b/api/interfaces/ILevelParagraphStylePropertiesOptions.html @@ -1,4 +1,4 @@ -ILevelParagraphStylePropertiesOptions | docx

Interface ILevelParagraphStylePropertiesOptions

interface ILevelParagraphStylePropertiesOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    contextualSpacing?: boolean;
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    outlineLevel?: number;
    rightTabStop?: number;
    spacing?: ISpacingProperties;
    thematicBreak?: boolean;
}

Hierarchy

Properties

alignment? +ILevelParagraphStylePropertiesOptions | docx

Interface ILevelParagraphStylePropertiesOptions

interface ILevelParagraphStylePropertiesOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    contextualSpacing?: boolean;
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    outlineLevel?: number;
    rightTabStop?: number;
    spacing?: ISpacingProperties;
    thematicBreak?: boolean;
}

Hierarchy

Properties

alignment? contextualSpacing? indent? keepLines? @@ -8,6 +8,6 @@ rightTabStop? spacing? thematicBreak? -

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly contextualSpacing

contextualSpacing?: boolean

Optional Readonly indent

indent?: IIndentAttributesProperties

Optional Readonly keepLines

keepLines?: boolean

Specifies that all lines of the paragraph are to be kept on a single page when possible.

-

Optional Readonly keepNext

keepNext?: boolean

Specifies that the paragraph (or at least part of it) should be rendered on the same page as the next paragraph when possible. If multiple paragraphs are to be kept together but they exceed a page, then the set of paragraphs begin on a new page and page breaks are used thereafter as needed.

-

Optional Readonly leftTabStop

leftTabStop?: number

Optional Readonly outlineLevel

outlineLevel?: number

Optional Readonly rightTabStop

rightTabStop?: number

Optional Readonly spacing

spacing?: ISpacingProperties

Optional Readonly thematicBreak

thematicBreak?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly contextualSpacing

contextualSpacing?: boolean

Optional Readonly indent

indent?: IIndentAttributesProperties

Optional Readonly keepLines

keepLines?: boolean

Specifies that all lines of the paragraph are to be kept on a single page when possible.

+

Optional Readonly keepNext

keepNext?: boolean

Specifies that the paragraph (or at least part of it) should be rendered on the same page as the next paragraph when possible. If multiple paragraphs are to be kept together but they exceed a page, then the set of paragraphs begin on a new page and page breaks are used thereafter as needed.

+

Optional Readonly leftTabStop

leftTabStop?: number

Optional Readonly outlineLevel

outlineLevel?: number

Optional Readonly rightTabStop

rightTabStop?: number

Optional Readonly spacing

spacing?: ISpacingProperties

Optional Readonly thematicBreak

thematicBreak?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ILevelsOptions.html b/api/interfaces/ILevelsOptions.html index cb5dc15ee2..a55d42845f 100644 --- a/api/interfaces/ILevelsOptions.html +++ b/api/interfaces/ILevelsOptions.html @@ -1,4 +1,4 @@ -ILevelsOptions | docx

Interface ILevelsOptions

interface ILevelsOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    format?: "none" | "bullet" | "decimal" | "upperRoman" | "lowerRoman" | "upperLetter" | "lowerLetter" | "ordinal" | "cardinalText" | "ordinalText" | "hex" | "chicago" | "ideographDigital" | "japaneseCounting" | "aiueo" | "iroha" | "decimalFullWidth" | "decimalHalfWidth" | "japaneseLegal" | "japaneseDigitalTenThousand" | "decimalEnclosedCircle" | "decimalFullWidth2" | "aiueoFullWidth" | "irohaFullWidth" | "decimalZero" | "ganada" | "chosung" | "decimalEnclosedFullstop" | "decimalEnclosedParen" | "decimalEnclosedCircleChinese" | "ideographEnclosedCircle" | "ideographTraditional" | "ideographZodiac" | "ideographZodiacTraditional" | "taiwaneseCounting" | "ideographLegalTraditional" | "taiwaneseCountingThousand" | "taiwaneseDigital" | "chineseCounting" | "chineseLegalSimplified" | "chineseCountingThousand" | "koreanDigital" | "koreanCounting" | "koreanLegal" | "koreanDigital2" | "vietnameseCounting" | "russianLower" | "russianUpper" | "numberInDash" | "hebrew1" | "hebrew2" | "arabicAlpha" | "arabicAbjad" | "hindiVowels" | "hindiConsonants" | "hindiNumbers" | "hindiCounting" | "thaiLetters" | "thaiNumbers" | "thaiCounting" | "bahtText" | "dollarText" | "custom";
    isLegalNumberingStyle?: boolean;
    level: number;
    start?: number;
    style?: {
        paragraph?: ILevelParagraphStylePropertiesOptions;
        run?: IRunStylePropertiesOptions;
    };
    suffix?: "space" | "nothing" | "tab";
    text?: string;
}

Properties

alignment? +ILevelsOptions | docx

Interface ILevelsOptions

interface ILevelsOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    format?: "none" | "bullet" | "decimal" | "upperRoman" | "lowerRoman" | "upperLetter" | "lowerLetter" | "ordinal" | "cardinalText" | "ordinalText" | "hex" | "chicago" | "ideographDigital" | "japaneseCounting" | "aiueo" | "iroha" | "decimalFullWidth" | "decimalHalfWidth" | "japaneseLegal" | "japaneseDigitalTenThousand" | "decimalEnclosedCircle" | "decimalFullWidth2" | "aiueoFullWidth" | "irohaFullWidth" | "decimalZero" | "ganada" | "chosung" | "decimalEnclosedFullstop" | "decimalEnclosedParen" | "decimalEnclosedCircleChinese" | "ideographEnclosedCircle" | "ideographTraditional" | "ideographZodiac" | "ideographZodiacTraditional" | "taiwaneseCounting" | "ideographLegalTraditional" | "taiwaneseCountingThousand" | "taiwaneseDigital" | "chineseCounting" | "chineseLegalSimplified" | "chineseCountingThousand" | "koreanDigital" | "koreanCounting" | "koreanLegal" | "koreanDigital2" | "vietnameseCounting" | "russianLower" | "russianUpper" | "numberInDash" | "hebrew1" | "hebrew2" | "arabicAlpha" | "arabicAbjad" | "hindiVowels" | "hindiConsonants" | "hindiNumbers" | "hindiCounting" | "thaiLetters" | "thaiNumbers" | "thaiCounting" | "bahtText" | "dollarText" | "custom";
    isLegalNumberingStyle?: boolean;
    level: number;
    start?: number;
    style?: {
        paragraph?: ILevelParagraphStylePropertiesOptions;
        run?: IRunStylePropertiesOptions;
    };
    suffix?: "space" | "nothing" | "tab";
    text?: string;
}

Properties

alignment? format? isLegalNumberingStyle? level @@ -6,4 +6,4 @@ style? suffix? text? -

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly format

format?: "none" | "bullet" | "decimal" | "upperRoman" | "lowerRoman" | "upperLetter" | "lowerLetter" | "ordinal" | "cardinalText" | "ordinalText" | "hex" | "chicago" | "ideographDigital" | "japaneseCounting" | "aiueo" | "iroha" | "decimalFullWidth" | "decimalHalfWidth" | "japaneseLegal" | "japaneseDigitalTenThousand" | "decimalEnclosedCircle" | "decimalFullWidth2" | "aiueoFullWidth" | "irohaFullWidth" | "decimalZero" | "ganada" | "chosung" | "decimalEnclosedFullstop" | "decimalEnclosedParen" | "decimalEnclosedCircleChinese" | "ideographEnclosedCircle" | "ideographTraditional" | "ideographZodiac" | "ideographZodiacTraditional" | "taiwaneseCounting" | "ideographLegalTraditional" | "taiwaneseCountingThousand" | "taiwaneseDigital" | "chineseCounting" | "chineseLegalSimplified" | "chineseCountingThousand" | "koreanDigital" | "koreanCounting" | "koreanLegal" | "koreanDigital2" | "vietnameseCounting" | "russianLower" | "russianUpper" | "numberInDash" | "hebrew1" | "hebrew2" | "arabicAlpha" | "arabicAbjad" | "hindiVowels" | "hindiConsonants" | "hindiNumbers" | "hindiCounting" | "thaiLetters" | "thaiNumbers" | "thaiCounting" | "bahtText" | "dollarText" | "custom"

Optional Readonly isLegalNumberingStyle

isLegalNumberingStyle?: boolean

Readonly level

level: number

Optional Readonly start

start?: number

Optional Readonly style

style?: {
    paragraph?: ILevelParagraphStylePropertiesOptions;
    run?: IRunStylePropertiesOptions;
}

Type declaration

Optional Readonly suffix

suffix?: "space" | "nothing" | "tab"

Optional Readonly text

text?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly format

format?: "none" | "bullet" | "decimal" | "upperRoman" | "lowerRoman" | "upperLetter" | "lowerLetter" | "ordinal" | "cardinalText" | "ordinalText" | "hex" | "chicago" | "ideographDigital" | "japaneseCounting" | "aiueo" | "iroha" | "decimalFullWidth" | "decimalHalfWidth" | "japaneseLegal" | "japaneseDigitalTenThousand" | "decimalEnclosedCircle" | "decimalFullWidth2" | "aiueoFullWidth" | "irohaFullWidth" | "decimalZero" | "ganada" | "chosung" | "decimalEnclosedFullstop" | "decimalEnclosedParen" | "decimalEnclosedCircleChinese" | "ideographEnclosedCircle" | "ideographTraditional" | "ideographZodiac" | "ideographZodiacTraditional" | "taiwaneseCounting" | "ideographLegalTraditional" | "taiwaneseCountingThousand" | "taiwaneseDigital" | "chineseCounting" | "chineseLegalSimplified" | "chineseCountingThousand" | "koreanDigital" | "koreanCounting" | "koreanLegal" | "koreanDigital2" | "vietnameseCounting" | "russianLower" | "russianUpper" | "numberInDash" | "hebrew1" | "hebrew2" | "arabicAlpha" | "arabicAbjad" | "hindiVowels" | "hindiConsonants" | "hindiNumbers" | "hindiCounting" | "thaiLetters" | "thaiNumbers" | "thaiCounting" | "bahtText" | "dollarText" | "custom"

Optional Readonly isLegalNumberingStyle

isLegalNumberingStyle?: boolean

Readonly level

level: number

Optional Readonly start

start?: number

Optional Readonly style

style?: {
    paragraph?: ILevelParagraphStylePropertiesOptions;
    run?: IRunStylePropertiesOptions;
}

Type declaration

Optional Readonly suffix

suffix?: "space" | "nothing" | "tab"

Optional Readonly text

text?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMargins.html b/api/interfaces/IMargins.html index b2687b04ae..c050c82cda 100644 --- a/api/interfaces/IMargins.html +++ b/api/interfaces/IMargins.html @@ -1,5 +1,5 @@ -IMargins | docx

Interface IMargins

interface IMargins {
    bottom?: number;
    left?: number;
    right?: number;
    top?: number;
}

Properties

bottom? +IMargins | docx

Interface IMargins

interface IMargins {
    bottom?: number;
    left?: number;
    right?: number;
    top?: number;
}

Properties

bottom? left? right? top? -

Properties

Optional Readonly bottom

bottom?: number

Optional Readonly left

left?: number

Optional Readonly right

right?: number

Optional Readonly top

top?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly bottom

bottom?: number

Optional Readonly left

left?: number

Optional Readonly right

right?: number

Optional Readonly top

top?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMathFractionOptions.html b/api/interfaces/IMathFractionOptions.html index 625fa3218f..aa01412b21 100644 --- a/api/interfaces/IMathFractionOptions.html +++ b/api/interfaces/IMathFractionOptions.html @@ -1,3 +1,3 @@ -IMathFractionOptions | docx

Interface IMathFractionOptions

interface IMathFractionOptions {
    denominator: readonly MathComponent[];
    numerator: readonly MathComponent[];
}

Properties

denominator +IMathFractionOptions | docx

Interface IMathFractionOptions

interface IMathFractionOptions {
    denominator: readonly MathComponent[];
    numerator: readonly MathComponent[];
}

Properties

denominator numerator -

Properties

Readonly denominator

denominator: readonly MathComponent[]

Readonly numerator

numerator: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly denominator

denominator: readonly MathComponent[]

Readonly numerator

numerator: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMathFunctionOptions.html b/api/interfaces/IMathFunctionOptions.html index 9ce71fb402..66b4538b48 100644 --- a/api/interfaces/IMathFunctionOptions.html +++ b/api/interfaces/IMathFunctionOptions.html @@ -1,3 +1,3 @@ -IMathFunctionOptions | docx

Interface IMathFunctionOptions

interface IMathFunctionOptions {
    children: readonly MathComponent[];
    name: readonly MathComponent[];
}

Properties

children +IMathFunctionOptions | docx

Interface IMathFunctionOptions

interface IMathFunctionOptions {
    children: readonly MathComponent[];
    name: readonly MathComponent[];
}

Properties

children name -

Properties

Readonly children

children: readonly MathComponent[]

Readonly name

name: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly children

children: readonly MathComponent[]

Readonly name

name: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMathIntegralOptions.html b/api/interfaces/IMathIntegralOptions.html index 8ada267a2f..7736622b15 100644 --- a/api/interfaces/IMathIntegralOptions.html +++ b/api/interfaces/IMathIntegralOptions.html @@ -1,4 +1,4 @@ -IMathIntegralOptions | docx

Interface IMathIntegralOptions

interface IMathIntegralOptions {
    children: readonly MathComponent[];
    subScript?: readonly MathComponent[];
    superScript?: readonly MathComponent[];
}

Properties

children +IMathIntegralOptions | docx

Interface IMathIntegralOptions

interface IMathIntegralOptions {
    children: readonly MathComponent[];
    subScript?: readonly MathComponent[];
    superScript?: readonly MathComponent[];
}

Properties

children subScript? superScript? -

Properties

Readonly children

children: readonly MathComponent[]

Optional Readonly subScript

subScript?: readonly MathComponent[]

Optional Readonly superScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly children

children: readonly MathComponent[]

Optional Readonly subScript

subScript?: readonly MathComponent[]

Optional Readonly superScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMathOptions.html b/api/interfaces/IMathOptions.html index b366060a55..becc4c1fde 100644 --- a/api/interfaces/IMathOptions.html +++ b/api/interfaces/IMathOptions.html @@ -1,2 +1,2 @@ -IMathOptions | docx

Interface IMathOptions

interface IMathOptions {
    children: readonly MathComponent[];
}

Properties

children -

Properties

Readonly children

children: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +IMathOptions | docx

Interface IMathOptions

interface IMathOptions {
    children: readonly MathComponent[];
}

Properties

children +

Properties

Readonly children

children: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMathPreSubSuperScriptOptions.html b/api/interfaces/IMathPreSubSuperScriptOptions.html index 0639d5ed25..75fb7dc0dc 100644 --- a/api/interfaces/IMathPreSubSuperScriptOptions.html +++ b/api/interfaces/IMathPreSubSuperScriptOptions.html @@ -1,4 +1,4 @@ -IMathPreSubSuperScriptOptions | docx

Interface IMathPreSubSuperScriptOptions

interface IMathPreSubSuperScriptOptions {
    children: readonly MathComponent[];
    subScript: readonly MathComponent[];
    superScript: readonly MathComponent[];
}

Properties

children +IMathPreSubSuperScriptOptions | docx

Interface IMathPreSubSuperScriptOptions

interface IMathPreSubSuperScriptOptions {
    children: readonly MathComponent[];
    subScript: readonly MathComponent[];
    superScript: readonly MathComponent[];
}

Properties

children subScript superScript -

Properties

Readonly children

children: readonly MathComponent[]

Readonly subScript

subScript: readonly MathComponent[]

Readonly superScript

superScript: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly children

children: readonly MathComponent[]

Readonly subScript

subScript: readonly MathComponent[]

Readonly superScript

superScript: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMathRadicalOptions.html b/api/interfaces/IMathRadicalOptions.html index 23693a4cc4..2725e16bad 100644 --- a/api/interfaces/IMathRadicalOptions.html +++ b/api/interfaces/IMathRadicalOptions.html @@ -1,3 +1,3 @@ -IMathRadicalOptions | docx

Interface IMathRadicalOptions

interface IMathRadicalOptions {
    children: readonly MathComponent[];
    degree?: readonly MathComponent[];
}

Properties

children +IMathRadicalOptions | docx

Interface IMathRadicalOptions

interface IMathRadicalOptions {
    children: readonly MathComponent[];
    degree?: readonly MathComponent[];
}

Properties

children degree? -

Properties

Readonly children

children: readonly MathComponent[]

Optional Readonly degree

degree?: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly children

children: readonly MathComponent[]

Optional Readonly degree

degree?: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMathSubScriptOptions.html b/api/interfaces/IMathSubScriptOptions.html index 9d82392247..030dd429d6 100644 --- a/api/interfaces/IMathSubScriptOptions.html +++ b/api/interfaces/IMathSubScriptOptions.html @@ -1,3 +1,3 @@ -IMathSubScriptOptions | docx

Interface IMathSubScriptOptions

interface IMathSubScriptOptions {
    children: readonly MathComponent[];
    subScript: readonly MathComponent[];
}

Properties

children +IMathSubScriptOptions | docx

Interface IMathSubScriptOptions

interface IMathSubScriptOptions {
    children: readonly MathComponent[];
    subScript: readonly MathComponent[];
}

Properties

children subScript -

Properties

Readonly children

children: readonly MathComponent[]

Readonly subScript

subScript: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly children

children: readonly MathComponent[]

Readonly subScript

subScript: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMathSubSuperScriptOptions.html b/api/interfaces/IMathSubSuperScriptOptions.html index 8511bb10aa..0081232fdb 100644 --- a/api/interfaces/IMathSubSuperScriptOptions.html +++ b/api/interfaces/IMathSubSuperScriptOptions.html @@ -1,4 +1,4 @@ -IMathSubSuperScriptOptions | docx

Interface IMathSubSuperScriptOptions

interface IMathSubSuperScriptOptions {
    children: readonly MathComponent[];
    subScript: readonly MathComponent[];
    superScript: readonly MathComponent[];
}

Properties

children +IMathSubSuperScriptOptions | docx

Interface IMathSubSuperScriptOptions

interface IMathSubSuperScriptOptions {
    children: readonly MathComponent[];
    subScript: readonly MathComponent[];
    superScript: readonly MathComponent[];
}

Properties

children subScript superScript -

Properties

Readonly children

children: readonly MathComponent[]

Readonly subScript

subScript: readonly MathComponent[]

Readonly superScript

superScript: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly children

children: readonly MathComponent[]

Readonly subScript

subScript: readonly MathComponent[]

Readonly superScript

superScript: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMathSumOptions.html b/api/interfaces/IMathSumOptions.html index 9d4d359b96..3b7608f820 100644 --- a/api/interfaces/IMathSumOptions.html +++ b/api/interfaces/IMathSumOptions.html @@ -1,4 +1,4 @@ -IMathSumOptions | docx

Interface IMathSumOptions

interface IMathSumOptions {
    children: readonly MathComponent[];
    subScript?: readonly MathComponent[];
    superScript?: readonly MathComponent[];
}

Properties

children +IMathSumOptions | docx

Interface IMathSumOptions

interface IMathSumOptions {
    children: readonly MathComponent[];
    subScript?: readonly MathComponent[];
    superScript?: readonly MathComponent[];
}

Properties

children subScript? superScript? -

Properties

Readonly children

children: readonly MathComponent[]

Optional Readonly subScript

subScript?: readonly MathComponent[]

Optional Readonly superScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly children

children: readonly MathComponent[]

Optional Readonly subScript

subScript?: readonly MathComponent[]

Optional Readonly superScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMathSuperScriptOptions.html b/api/interfaces/IMathSuperScriptOptions.html index de1696251d..4649f36ada 100644 --- a/api/interfaces/IMathSuperScriptOptions.html +++ b/api/interfaces/IMathSuperScriptOptions.html @@ -1,3 +1,3 @@ -IMathSuperScriptOptions | docx

Interface IMathSuperScriptOptions

interface IMathSuperScriptOptions {
    children: readonly MathComponent[];
    superScript: readonly MathComponent[];
}

Properties

children +IMathSuperScriptOptions | docx

Interface IMathSuperScriptOptions

interface IMathSuperScriptOptions {
    children: readonly MathComponent[];
    superScript: readonly MathComponent[];
}

Properties

children superScript -

Properties

Readonly children

children: readonly MathComponent[]

Readonly superScript

superScript: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly children

children: readonly MathComponent[]

Readonly superScript

superScript: readonly MathComponent[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMediaData.html b/api/interfaces/IMediaData.html index e543738a01..efa27b626c 100644 --- a/api/interfaces/IMediaData.html +++ b/api/interfaces/IMediaData.html @@ -1,4 +1,4 @@ -IMediaData | docx

Interface IMediaData

interface IMediaData {
    fileName: string;
    stream: Buffer | Uint8Array | ArrayBuffer;
    transformation: IMediaDataTransformation;
}

Properties

fileName +IMediaData | docx

Interface IMediaData

interface IMediaData {
    fileName: string;
    stream: Buffer | Uint8Array | ArrayBuffer;
    transformation: IMediaDataTransformation;
}

Properties

fileName stream transformation -

Properties

Readonly fileName

fileName: string

Readonly stream

stream: Buffer | Uint8Array | ArrayBuffer

Readonly transformation

transformation: IMediaDataTransformation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly fileName

fileName: string

Readonly stream

stream: Buffer | Uint8Array | ArrayBuffer

Readonly transformation

transformation: IMediaDataTransformation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMediaDataTransformation.html b/api/interfaces/IMediaDataTransformation.html index dbe736f9a5..ba0955b7a0 100644 --- a/api/interfaces/IMediaDataTransformation.html +++ b/api/interfaces/IMediaDataTransformation.html @@ -1,5 +1,5 @@ -IMediaDataTransformation | docx

Interface IMediaDataTransformation

interface IMediaDataTransformation {
    emus: {
        x: number;
        y: number;
    };
    flip?: {
        horizontal?: boolean;
        vertical?: boolean;
    };
    pixels: {
        x: number;
        y: number;
    };
    rotation?: number;
}

Properties

emus +IMediaDataTransformation | docx

Interface IMediaDataTransformation

interface IMediaDataTransformation {
    emus: {
        x: number;
        y: number;
    };
    flip?: {
        horizontal?: boolean;
        vertical?: boolean;
    };
    pixels: {
        x: number;
        y: number;
    };
    rotation?: number;
}

Properties

emus flip? pixels rotation? -

Properties

Readonly emus

emus: {
    x: number;
    y: number;
}

Type declaration

  • Readonly x: number
  • Readonly y: number

Optional Readonly flip

flip?: {
    horizontal?: boolean;
    vertical?: boolean;
}

Type declaration

  • Optional Readonly horizontal?: boolean
  • Optional Readonly vertical?: boolean

Readonly pixels

pixels: {
    x: number;
    y: number;
}

Type declaration

  • Readonly x: number
  • Readonly y: number

Optional Readonly rotation

rotation?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly emus

emus: {
    x: number;
    y: number;
}

Type declaration

  • Readonly x: number
  • Readonly y: number

Optional Readonly flip

flip?: {
    horizontal?: boolean;
    vertical?: boolean;
}

Type declaration

  • Optional Readonly horizontal?: boolean
  • Optional Readonly vertical?: boolean

Readonly pixels

pixels: {
    x: number;
    y: number;
}

Type declaration

  • Readonly x: number
  • Readonly y: number

Optional Readonly rotation

rotation?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IMediaTransformation.html b/api/interfaces/IMediaTransformation.html index 287ebcb606..c6429e64a1 100644 --- a/api/interfaces/IMediaTransformation.html +++ b/api/interfaces/IMediaTransformation.html @@ -1,5 +1,5 @@ -IMediaTransformation | docx

Interface IMediaTransformation

interface IMediaTransformation {
    flip?: {
        horizontal?: boolean;
        vertical?: boolean;
    };
    height: number;
    rotation?: number;
    width: number;
}

Properties

flip? +IMediaTransformation | docx

Interface IMediaTransformation

interface IMediaTransformation {
    flip?: {
        horizontal?: boolean;
        vertical?: boolean;
    };
    height: number;
    rotation?: number;
    width: number;
}

Properties

flip? height rotation? width -

Properties

Optional Readonly flip

flip?: {
    horizontal?: boolean;
    vertical?: boolean;
}

Type declaration

  • Optional Readonly horizontal?: boolean
  • Optional Readonly vertical?: boolean

Readonly height

height: number

Optional Readonly rotation

rotation?: number

Readonly width

width: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly flip

flip?: {
    horizontal?: boolean;
    vertical?: boolean;
}

Type declaration

  • Optional Readonly horizontal?: boolean
  • Optional Readonly vertical?: boolean

Readonly height

height: number

Optional Readonly rotation

rotation?: number

Readonly width

width: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/INumberingOptions.html b/api/interfaces/INumberingOptions.html index f2d0f29e09..c8561088cf 100644 --- a/api/interfaces/INumberingOptions.html +++ b/api/interfaces/INumberingOptions.html @@ -1,2 +1,2 @@ -INumberingOptions | docx

Interface INumberingOptions

interface INumberingOptions {
    config: readonly {
        levels: readonly ILevelsOptions[];
        reference: string;
    }[];
}

Properties

config -

Properties

Readonly config

config: readonly {
    levels: readonly ILevelsOptions[];
    reference: string;
}[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +INumberingOptions | docx

Interface INumberingOptions

interface INumberingOptions {
    config: readonly {
        levels: readonly ILevelsOptions[];
        reference: string;
    }[];
}

Properties

config +

Properties

Readonly config

config: readonly {
    levels: readonly ILevelsOptions[];
    reference: string;
}[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IPageBorderAttributes.html b/api/interfaces/IPageBorderAttributes.html index 918df5b8f7..85c10bfa2e 100644 --- a/api/interfaces/IPageBorderAttributes.html +++ b/api/interfaces/IPageBorderAttributes.html @@ -1,4 +1,4 @@ -IPageBorderAttributes | docx

Interface IPageBorderAttributes

interface IPageBorderAttributes {
    display?: "allPages" | "firstPage" | "notFirstPage";
    offsetFrom?: "text" | "page";
    zOrder?: "back" | "front";
}

Properties

display? +IPageBorderAttributes | docx

Interface IPageBorderAttributes

interface IPageBorderAttributes {
    display?: "allPages" | "firstPage" | "notFirstPage";
    offsetFrom?: "text" | "page";
    zOrder?: "back" | "front";
}

Properties

display? offsetFrom? zOrder? -

Properties

Optional Readonly display

display?: "allPages" | "firstPage" | "notFirstPage"

Optional Readonly offsetFrom

offsetFrom?: "text" | "page"

Optional Readonly zOrder

zOrder?: "back" | "front"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly display

display?: "allPages" | "firstPage" | "notFirstPage"

Optional Readonly offsetFrom

offsetFrom?: "text" | "page"

Optional Readonly zOrder

zOrder?: "back" | "front"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IPageBordersOptions.html b/api/interfaces/IPageBordersOptions.html index b5ae293416..b948116204 100644 --- a/api/interfaces/IPageBordersOptions.html +++ b/api/interfaces/IPageBordersOptions.html @@ -1,6 +1,6 @@ -IPageBordersOptions | docx

Interface IPageBordersOptions

interface IPageBordersOptions {
    pageBorderBottom?: IBorderOptions;
    pageBorderLeft?: IBorderOptions;
    pageBorderRight?: IBorderOptions;
    pageBorderTop?: IBorderOptions;
    pageBorders?: IPageBorderAttributes;
}

Properties

pageBorderBottom? +IPageBordersOptions | docx

Interface IPageBordersOptions

interface IPageBordersOptions {
    pageBorderBottom?: IBorderOptions;
    pageBorderLeft?: IBorderOptions;
    pageBorderRight?: IBorderOptions;
    pageBorderTop?: IBorderOptions;
    pageBorders?: IPageBorderAttributes;
}

Properties

pageBorderBottom? pageBorderLeft? pageBorderRight? pageBorderTop? pageBorders? -

Properties

Optional Readonly pageBorderBottom

pageBorderBottom?: IBorderOptions

Optional Readonly pageBorderLeft

pageBorderLeft?: IBorderOptions

Optional Readonly pageBorderRight

pageBorderRight?: IBorderOptions

Optional Readonly pageBorderTop

pageBorderTop?: IBorderOptions

Optional Readonly pageBorders

pageBorders?: IPageBorderAttributes

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly pageBorderBottom

pageBorderBottom?: IBorderOptions

Optional Readonly pageBorderLeft

pageBorderLeft?: IBorderOptions

Optional Readonly pageBorderRight

pageBorderRight?: IBorderOptions

Optional Readonly pageBorderTop

pageBorderTop?: IBorderOptions

Optional Readonly pageBorders

pageBorders?: IPageBorderAttributes

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IPageNumberTypeAttributes.html b/api/interfaces/IPageNumberTypeAttributes.html index 64abbc5238..b694a36c62 100644 --- a/api/interfaces/IPageNumberTypeAttributes.html +++ b/api/interfaces/IPageNumberTypeAttributes.html @@ -1,4 +1,4 @@ -IPageNumberTypeAttributes | docx

Interface IPageNumberTypeAttributes

interface IPageNumberTypeAttributes {
    formatType?: "none" | "bullet" | "decimal" | "upperRoman" | "lowerRoman" | "upperLetter" | "lowerLetter" | "ordinal" | "cardinalText" | "ordinalText" | "hex" | "chicago" | "ideographDigital" | "japaneseCounting" | "aiueo" | "iroha" | "decimalFullWidth" | "decimalHalfWidth" | "japaneseLegal" | "japaneseDigitalTenThousand" | "decimalEnclosedCircle" | "decimalFullWidth2" | "aiueoFullWidth" | "irohaFullWidth" | "decimalZero" | "ganada" | "chosung" | "decimalEnclosedFullstop" | "decimalEnclosedParen" | "decimalEnclosedCircleChinese" | "ideographEnclosedCircle" | "ideographTraditional" | "ideographZodiac" | "ideographZodiacTraditional" | "taiwaneseCounting" | "ideographLegalTraditional" | "taiwaneseCountingThousand" | "taiwaneseDigital" | "chineseCounting" | "chineseLegalSimplified" | "chineseCountingThousand" | "koreanDigital" | "koreanCounting" | "koreanLegal" | "koreanDigital2" | "vietnameseCounting" | "russianLower" | "russianUpper" | "numberInDash" | "hebrew1" | "hebrew2" | "arabicAlpha" | "arabicAbjad" | "hindiVowels" | "hindiConsonants" | "hindiNumbers" | "hindiCounting" | "thaiLetters" | "thaiNumbers" | "thaiCounting" | "bahtText" | "dollarText";
    separator?: "hyphen" | "period" | "colon" | "emDash" | "endash";
    start?: number;
}

Properties

formatType? +IPageNumberTypeAttributes | docx

Interface IPageNumberTypeAttributes

interface IPageNumberTypeAttributes {
    formatType?: "none" | "bullet" | "decimal" | "upperRoman" | "lowerRoman" | "upperLetter" | "lowerLetter" | "ordinal" | "cardinalText" | "ordinalText" | "hex" | "chicago" | "ideographDigital" | "japaneseCounting" | "aiueo" | "iroha" | "decimalFullWidth" | "decimalHalfWidth" | "japaneseLegal" | "japaneseDigitalTenThousand" | "decimalEnclosedCircle" | "decimalFullWidth2" | "aiueoFullWidth" | "irohaFullWidth" | "decimalZero" | "ganada" | "chosung" | "decimalEnclosedFullstop" | "decimalEnclosedParen" | "decimalEnclosedCircleChinese" | "ideographEnclosedCircle" | "ideographTraditional" | "ideographZodiac" | "ideographZodiacTraditional" | "taiwaneseCounting" | "ideographLegalTraditional" | "taiwaneseCountingThousand" | "taiwaneseDigital" | "chineseCounting" | "chineseLegalSimplified" | "chineseCountingThousand" | "koreanDigital" | "koreanCounting" | "koreanLegal" | "koreanDigital2" | "vietnameseCounting" | "russianLower" | "russianUpper" | "numberInDash" | "hebrew1" | "hebrew2" | "arabicAlpha" | "arabicAbjad" | "hindiVowels" | "hindiConsonants" | "hindiNumbers" | "hindiCounting" | "thaiLetters" | "thaiNumbers" | "thaiCounting" | "bahtText" | "dollarText";
    separator?: "hyphen" | "period" | "colon" | "emDash" | "endash";
    start?: number;
}

Properties

formatType? separator? start? -

Properties

Optional Readonly formatType

formatType?: "none" | "bullet" | "decimal" | "upperRoman" | "lowerRoman" | "upperLetter" | "lowerLetter" | "ordinal" | "cardinalText" | "ordinalText" | "hex" | "chicago" | "ideographDigital" | "japaneseCounting" | "aiueo" | "iroha" | "decimalFullWidth" | "decimalHalfWidth" | "japaneseLegal" | "japaneseDigitalTenThousand" | "decimalEnclosedCircle" | "decimalFullWidth2" | "aiueoFullWidth" | "irohaFullWidth" | "decimalZero" | "ganada" | "chosung" | "decimalEnclosedFullstop" | "decimalEnclosedParen" | "decimalEnclosedCircleChinese" | "ideographEnclosedCircle" | "ideographTraditional" | "ideographZodiac" | "ideographZodiacTraditional" | "taiwaneseCounting" | "ideographLegalTraditional" | "taiwaneseCountingThousand" | "taiwaneseDigital" | "chineseCounting" | "chineseLegalSimplified" | "chineseCountingThousand" | "koreanDigital" | "koreanCounting" | "koreanLegal" | "koreanDigital2" | "vietnameseCounting" | "russianLower" | "russianUpper" | "numberInDash" | "hebrew1" | "hebrew2" | "arabicAlpha" | "arabicAbjad" | "hindiVowels" | "hindiConsonants" | "hindiNumbers" | "hindiCounting" | "thaiLetters" | "thaiNumbers" | "thaiCounting" | "bahtText" | "dollarText"

Optional Readonly separator

separator?: "hyphen" | "period" | "colon" | "emDash" | "endash"

Optional Readonly start

start?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly formatType

formatType?: "none" | "bullet" | "decimal" | "upperRoman" | "lowerRoman" | "upperLetter" | "lowerLetter" | "ordinal" | "cardinalText" | "ordinalText" | "hex" | "chicago" | "ideographDigital" | "japaneseCounting" | "aiueo" | "iroha" | "decimalFullWidth" | "decimalHalfWidth" | "japaneseLegal" | "japaneseDigitalTenThousand" | "decimalEnclosedCircle" | "decimalFullWidth2" | "aiueoFullWidth" | "irohaFullWidth" | "decimalZero" | "ganada" | "chosung" | "decimalEnclosedFullstop" | "decimalEnclosedParen" | "decimalEnclosedCircleChinese" | "ideographEnclosedCircle" | "ideographTraditional" | "ideographZodiac" | "ideographZodiacTraditional" | "taiwaneseCounting" | "ideographLegalTraditional" | "taiwaneseCountingThousand" | "taiwaneseDigital" | "chineseCounting" | "chineseLegalSimplified" | "chineseCountingThousand" | "koreanDigital" | "koreanCounting" | "koreanLegal" | "koreanDigital2" | "vietnameseCounting" | "russianLower" | "russianUpper" | "numberInDash" | "hebrew1" | "hebrew2" | "arabicAlpha" | "arabicAbjad" | "hindiVowels" | "hindiConsonants" | "hindiNumbers" | "hindiCounting" | "thaiLetters" | "thaiNumbers" | "thaiCounting" | "bahtText" | "dollarText"

Optional Readonly separator

separator?: "hyphen" | "period" | "colon" | "emDash" | "endash"

Optional Readonly start

start?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IParagraphOptions.html b/api/interfaces/IParagraphOptions.html index ca7cd6ba59..98f61f3c58 100644 --- a/api/interfaces/IParagraphOptions.html +++ b/api/interfaces/IParagraphOptions.html @@ -1,4 +1,4 @@ -IParagraphOptions | docx

Interface IParagraphOptions

interface IParagraphOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    autoSpaceEastAsianText?: boolean;
    bidirectional?: boolean;
    border?: IBordersOptions;
    bullet?: {
        level: number;
    };
    children?: readonly ParagraphChild[];
    contextualSpacing?: boolean;
    frame?: IFrameOptions;
    heading?: "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Title";
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: {
        custom?: boolean;
        instance?: number;
        level: number;
        reference: string;
    };
    outlineLevel?: number;
    overflowPunctuation?: boolean;
    pageBreakBefore?: boolean;
    rightTabStop?: number;
    run?: IRunOptions;
    scale?: number;
    shading?: IShadingAttributesProperties;
    spacing?: ISpacingProperties;
    style?: string;
    suppressLineNumbers?: boolean;
    tabStops?: readonly TabStopDefinition[];
    text?: string;
    thematicBreak?: boolean;
    widowControl?: boolean;
    wordWrap?: boolean;
}

Hierarchy

Properties

alignment? +IParagraphOptions | docx

Interface IParagraphOptions

interface IParagraphOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    autoSpaceEastAsianText?: boolean;
    bidirectional?: boolean;
    border?: IBordersOptions;
    bullet?: {
        level: number;
    };
    children?: readonly ParagraphChild[];
    contextualSpacing?: boolean;
    frame?: IFrameOptions;
    heading?: "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Title";
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: {
        custom?: boolean;
        instance?: number;
        level: number;
        reference: string;
    };
    outlineLevel?: number;
    overflowPunctuation?: boolean;
    pageBreakBefore?: boolean;
    rightTabStop?: number;
    run?: IRunOptions;
    scale?: number;
    shading?: IShadingAttributesProperties;
    spacing?: ISpacingProperties;
    style?: string;
    suppressLineNumbers?: boolean;
    tabStops?: readonly TabStopDefinition[];
    text?: string;
    thematicBreak?: boolean;
    widowControl?: boolean;
    wordWrap?: boolean;
}

Hierarchy

Properties

alignment? autoSpaceEastAsianText? bidirectional? border? @@ -27,9 +27,9 @@ thematicBreak? widowControl? wordWrap? -

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly autoSpaceEastAsianText

autoSpaceEastAsianText?: boolean

This element specifies whether inter-character spacing shall automatically be adjusted between regions of numbers and regions of East Asian text in the current paragraph. These regions shall be determined by the Unicode character values of the text content within the paragraph. +

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly autoSpaceEastAsianText

autoSpaceEastAsianText?: boolean

This element specifies whether inter-character spacing shall automatically be adjusted between regions of numbers and regions of East Asian text in the current paragraph. These regions shall be determined by the Unicode character values of the text content within the paragraph. This only works in Microsoft Word. It is not part of the ECMA-376 OOXML standard.

-

Optional Readonly bidirectional

bidirectional?: boolean

Optional Readonly border

border?: IBordersOptions

Optional Readonly bullet

bullet?: {
    level: number;
}

Type declaration

  • Readonly level: number

Optional Readonly children

children?: readonly ParagraphChild[]

Optional Readonly contextualSpacing

contextualSpacing?: boolean

Optional Readonly frame

frame?: IFrameOptions

Optional Readonly heading

heading?: "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Title"

Optional Readonly indent

indent?: IIndentAttributesProperties

Optional Readonly keepLines

keepLines?: boolean

Specifies that all lines of the paragraph are to be kept on a single page when possible.

-

Optional Readonly keepNext

keepNext?: boolean

Specifies that the paragraph (or at least part of it) should be rendered on the same page as the next paragraph when possible. If multiple paragraphs are to be kept together but they exceed a page, then the set of paragraphs begin on a new page and page breaks are used thereafter as needed.

-

Optional Readonly leftTabStop

leftTabStop?: number

Optional Readonly numbering

numbering?: {
    custom?: boolean;
    instance?: number;
    level: number;
    reference: string;
}

Type declaration

  • Optional Readonly custom?: boolean
  • Optional Readonly instance?: number
  • Readonly level: number
  • Readonly reference: string

Optional Readonly outlineLevel

outlineLevel?: number

Optional Readonly overflowPunctuation

overflowPunctuation?: boolean

Optional Readonly pageBreakBefore

pageBreakBefore?: boolean

Optional Readonly rightTabStop

rightTabStop?: number

Optional Readonly run

run?: IRunOptions

Reference: ECMA-376, 3rd Edition (June, 2011), Fundamentals and Markup Language Reference § 17.3.1.29.

-

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly spacing

spacing?: ISpacingProperties

Optional Readonly style

style?: string

Optional Readonly suppressLineNumbers

suppressLineNumbers?: boolean

Optional Readonly tabStops

tabStops?: readonly TabStopDefinition[]

Optional Readonly text

text?: string

Optional Readonly thematicBreak

thematicBreak?: boolean

Optional Readonly widowControl

widowControl?: boolean

Optional Readonly wordWrap

wordWrap?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional Readonly bidirectional

bidirectional?: boolean

Optional Readonly border

border?: IBordersOptions

Optional Readonly bullet

bullet?: {
    level: number;
}

Type declaration

  • Readonly level: number

Optional Readonly children

children?: readonly ParagraphChild[]

Optional Readonly contextualSpacing

contextualSpacing?: boolean

Optional Readonly frame

frame?: IFrameOptions

Optional Readonly heading

heading?: "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Title"

Optional Readonly indent

indent?: IIndentAttributesProperties

Optional Readonly keepLines

keepLines?: boolean

Specifies that all lines of the paragraph are to be kept on a single page when possible.

+

Optional Readonly keepNext

keepNext?: boolean

Specifies that the paragraph (or at least part of it) should be rendered on the same page as the next paragraph when possible. If multiple paragraphs are to be kept together but they exceed a page, then the set of paragraphs begin on a new page and page breaks are used thereafter as needed.

+

Optional Readonly leftTabStop

leftTabStop?: number

Optional Readonly numbering

numbering?: {
    custom?: boolean;
    instance?: number;
    level: number;
    reference: string;
}

Type declaration

  • Optional Readonly custom?: boolean
  • Optional Readonly instance?: number
  • Readonly level: number
  • Readonly reference: string

Optional Readonly outlineLevel

outlineLevel?: number

Optional Readonly overflowPunctuation

overflowPunctuation?: boolean

Optional Readonly pageBreakBefore

pageBreakBefore?: boolean

Optional Readonly rightTabStop

rightTabStop?: number

Optional Readonly run

run?: IRunOptions

Reference: ECMA-376, 3rd Edition (June, 2011), Fundamentals and Markup Language Reference § 17.3.1.29.

+

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly spacing

spacing?: ISpacingProperties

Optional Readonly style

style?: string

Optional Readonly suppressLineNumbers

suppressLineNumbers?: boolean

Optional Readonly tabStops

tabStops?: readonly TabStopDefinition[]

Optional Readonly text

text?: string

Optional Readonly thematicBreak

thematicBreak?: boolean

Optional Readonly widowControl

widowControl?: boolean

Optional Readonly wordWrap

wordWrap?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IParagraphPropertiesOptions.html b/api/interfaces/IParagraphPropertiesOptions.html index a9cf4a1fcb..bf4d4a564c 100644 --- a/api/interfaces/IParagraphPropertiesOptions.html +++ b/api/interfaces/IParagraphPropertiesOptions.html @@ -1,4 +1,4 @@ -IParagraphPropertiesOptions | docx

Interface IParagraphPropertiesOptions

interface IParagraphPropertiesOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    autoSpaceEastAsianText?: boolean;
    bidirectional?: boolean;
    border?: IBordersOptions;
    bullet?: {
        level: number;
    };
    contextualSpacing?: boolean;
    frame?: IFrameOptions;
    heading?: "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Title";
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: {
        custom?: boolean;
        instance?: number;
        level: number;
        reference: string;
    };
    outlineLevel?: number;
    overflowPunctuation?: boolean;
    pageBreakBefore?: boolean;
    rightTabStop?: number;
    run?: IRunOptions;
    scale?: number;
    shading?: IShadingAttributesProperties;
    spacing?: ISpacingProperties;
    style?: string;
    suppressLineNumbers?: boolean;
    tabStops?: readonly TabStopDefinition[];
    thematicBreak?: boolean;
    widowControl?: boolean;
    wordWrap?: boolean;
}

Hierarchy

Properties

alignment? +IParagraphPropertiesOptions | docx

Interface IParagraphPropertiesOptions

interface IParagraphPropertiesOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    autoSpaceEastAsianText?: boolean;
    bidirectional?: boolean;
    border?: IBordersOptions;
    bullet?: {
        level: number;
    };
    contextualSpacing?: boolean;
    frame?: IFrameOptions;
    heading?: "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Title";
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: {
        custom?: boolean;
        instance?: number;
        level: number;
        reference: string;
    };
    outlineLevel?: number;
    overflowPunctuation?: boolean;
    pageBreakBefore?: boolean;
    rightTabStop?: number;
    run?: IRunOptions;
    scale?: number;
    shading?: IShadingAttributesProperties;
    spacing?: ISpacingProperties;
    style?: string;
    suppressLineNumbers?: boolean;
    tabStops?: readonly TabStopDefinition[];
    thematicBreak?: boolean;
    widowControl?: boolean;
    wordWrap?: boolean;
}

Hierarchy

Properties

alignment? autoSpaceEastAsianText? bidirectional? border? @@ -25,9 +25,9 @@ thematicBreak? widowControl? wordWrap? -

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly autoSpaceEastAsianText

autoSpaceEastAsianText?: boolean

This element specifies whether inter-character spacing shall automatically be adjusted between regions of numbers and regions of East Asian text in the current paragraph. These regions shall be determined by the Unicode character values of the text content within the paragraph. +

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly autoSpaceEastAsianText

autoSpaceEastAsianText?: boolean

This element specifies whether inter-character spacing shall automatically be adjusted between regions of numbers and regions of East Asian text in the current paragraph. These regions shall be determined by the Unicode character values of the text content within the paragraph. This only works in Microsoft Word. It is not part of the ECMA-376 OOXML standard.

-

Optional Readonly bidirectional

bidirectional?: boolean

Optional Readonly border

border?: IBordersOptions

Optional Readonly bullet

bullet?: {
    level: number;
}

Type declaration

  • Readonly level: number

Optional Readonly contextualSpacing

contextualSpacing?: boolean

Optional Readonly frame

frame?: IFrameOptions

Optional Readonly heading

heading?: "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Title"

Optional Readonly indent

indent?: IIndentAttributesProperties

Optional Readonly keepLines

keepLines?: boolean

Specifies that all lines of the paragraph are to be kept on a single page when possible.

-

Optional Readonly keepNext

keepNext?: boolean

Specifies that the paragraph (or at least part of it) should be rendered on the same page as the next paragraph when possible. If multiple paragraphs are to be kept together but they exceed a page, then the set of paragraphs begin on a new page and page breaks are used thereafter as needed.

-

Optional Readonly leftTabStop

leftTabStop?: number

Optional Readonly numbering

numbering?: {
    custom?: boolean;
    instance?: number;
    level: number;
    reference: string;
}

Type declaration

  • Optional Readonly custom?: boolean
  • Optional Readonly instance?: number
  • Readonly level: number
  • Readonly reference: string

Optional Readonly outlineLevel

outlineLevel?: number

Optional Readonly overflowPunctuation

overflowPunctuation?: boolean

Optional Readonly pageBreakBefore

pageBreakBefore?: boolean

Optional Readonly rightTabStop

rightTabStop?: number

Optional Readonly run

run?: IRunOptions

Reference: ECMA-376, 3rd Edition (June, 2011), Fundamentals and Markup Language Reference § 17.3.1.29.

-

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly spacing

spacing?: ISpacingProperties

Optional Readonly style

style?: string

Optional Readonly suppressLineNumbers

suppressLineNumbers?: boolean

Optional Readonly tabStops

tabStops?: readonly TabStopDefinition[]

Optional Readonly thematicBreak

thematicBreak?: boolean

Optional Readonly widowControl

widowControl?: boolean

Optional Readonly wordWrap

wordWrap?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional Readonly bidirectional

bidirectional?: boolean

Optional Readonly border

border?: IBordersOptions

Optional Readonly bullet

bullet?: {
    level: number;
}

Type declaration

  • Readonly level: number

Optional Readonly contextualSpacing

contextualSpacing?: boolean

Optional Readonly frame

frame?: IFrameOptions

Optional Readonly heading

heading?: "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Title"

Optional Readonly indent

indent?: IIndentAttributesProperties

Optional Readonly keepLines

keepLines?: boolean

Specifies that all lines of the paragraph are to be kept on a single page when possible.

+

Optional Readonly keepNext

keepNext?: boolean

Specifies that the paragraph (or at least part of it) should be rendered on the same page as the next paragraph when possible. If multiple paragraphs are to be kept together but they exceed a page, then the set of paragraphs begin on a new page and page breaks are used thereafter as needed.

+

Optional Readonly leftTabStop

leftTabStop?: number

Optional Readonly numbering

numbering?: {
    custom?: boolean;
    instance?: number;
    level: number;
    reference: string;
}

Type declaration

  • Optional Readonly custom?: boolean
  • Optional Readonly instance?: number
  • Readonly level: number
  • Readonly reference: string

Optional Readonly outlineLevel

outlineLevel?: number

Optional Readonly overflowPunctuation

overflowPunctuation?: boolean

Optional Readonly pageBreakBefore

pageBreakBefore?: boolean

Optional Readonly rightTabStop

rightTabStop?: number

Optional Readonly run

run?: IRunOptions

Reference: ECMA-376, 3rd Edition (June, 2011), Fundamentals and Markup Language Reference § 17.3.1.29.

+

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly spacing

spacing?: ISpacingProperties

Optional Readonly style

style?: string

Optional Readonly suppressLineNumbers

suppressLineNumbers?: boolean

Optional Readonly tabStops

tabStops?: readonly TabStopDefinition[]

Optional Readonly thematicBreak

thematicBreak?: boolean

Optional Readonly widowControl

widowControl?: boolean

Optional Readonly wordWrap

wordWrap?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IParagraphStyleOptions.html b/api/interfaces/IParagraphStyleOptions.html index 4aa7ebc8b2..643089b9a6 100644 --- a/api/interfaces/IParagraphStyleOptions.html +++ b/api/interfaces/IParagraphStyleOptions.html @@ -1,4 +1,4 @@ -IParagraphStyleOptions | docx

Interface IParagraphStyleOptions

interface IParagraphStyleOptions {
    basedOn?: string;
    id: string;
    link?: string;
    name?: string;
    next?: string;
    paragraph?: IParagraphStylePropertiesOptions;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy

Properties

basedOn? +IParagraphStyleOptions | docx

Interface IParagraphStyleOptions

interface IParagraphStyleOptions {
    basedOn?: string;
    id: string;
    link?: string;
    name?: string;
    next?: string;
    paragraph?: IParagraphStylePropertiesOptions;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy

Properties

basedOn? id link? name? @@ -13,4 +13,4 @@ Note that if the type of the current style must match the type of the style upon which it is based or the basedOn element will be ignored. However, if the current style is a numbering style, then the basedOn element is ignored.

WARNING: You cannot set basedOn to be the same as name. This is akin to inheriting from itself. This creates a cyclic dependency and cause undesirable behavior.

-

Readonly id

id: string

Optional Readonly link

link?: string

Optional Readonly name

name?: string

Optional Readonly next

next?: string

Optional Readonly paragraph

paragraph?: IParagraphStylePropertiesOptions

Optional Readonly quickFormat

quickFormat?: boolean

Optional Readonly run

run?: IRunStylePropertiesOptions

Optional Readonly semiHidden

semiHidden?: boolean

Optional Readonly uiPriority

uiPriority?: number

Optional Readonly unhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Readonly id

id: string

Optional Readonly link

link?: string

Optional Readonly name

name?: string

Optional Readonly next

next?: string

Optional Readonly paragraph

paragraph?: IParagraphStylePropertiesOptions

Optional Readonly quickFormat

quickFormat?: boolean

Optional Readonly run

run?: IRunStylePropertiesOptions

Optional Readonly semiHidden

semiHidden?: boolean

Optional Readonly uiPriority

uiPriority?: number

Optional Readonly unhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IParagraphStylePropertiesOptions.html b/api/interfaces/IParagraphStylePropertiesOptions.html index 5ed4f5e9e4..d038e8eb0a 100644 --- a/api/interfaces/IParagraphStylePropertiesOptions.html +++ b/api/interfaces/IParagraphStylePropertiesOptions.html @@ -1,4 +1,4 @@ -IParagraphStylePropertiesOptions | docx

Interface IParagraphStylePropertiesOptions

interface IParagraphStylePropertiesOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    contextualSpacing?: boolean;
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: {
        custom?: boolean;
        instance?: number;
        level: number;
        reference: string;
    };
    outlineLevel?: number;
    rightTabStop?: number;
    spacing?: ISpacingProperties;
    thematicBreak?: boolean;
}

Hierarchy

Properties

alignment? +IParagraphStylePropertiesOptions | docx

Interface IParagraphStylePropertiesOptions

interface IParagraphStylePropertiesOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    contextualSpacing?: boolean;
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: {
        custom?: boolean;
        instance?: number;
        level: number;
        reference: string;
    };
    outlineLevel?: number;
    rightTabStop?: number;
    spacing?: ISpacingProperties;
    thematicBreak?: boolean;
}

Hierarchy

Properties

alignment? contextualSpacing? indent? keepLines? @@ -9,6 +9,6 @@ rightTabStop? spacing? thematicBreak? -

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly contextualSpacing

contextualSpacing?: boolean

Optional Readonly indent

indent?: IIndentAttributesProperties

Optional Readonly keepLines

keepLines?: boolean

Specifies that all lines of the paragraph are to be kept on a single page when possible.

-

Optional Readonly keepNext

keepNext?: boolean

Specifies that the paragraph (or at least part of it) should be rendered on the same page as the next paragraph when possible. If multiple paragraphs are to be kept together but they exceed a page, then the set of paragraphs begin on a new page and page breaks are used thereafter as needed.

-

Optional Readonly leftTabStop

leftTabStop?: number

Optional Readonly numbering

numbering?: {
    custom?: boolean;
    instance?: number;
    level: number;
    reference: string;
}

Type declaration

  • Optional Readonly custom?: boolean
  • Optional Readonly instance?: number
  • Readonly level: number
  • Readonly reference: string

Optional Readonly outlineLevel

outlineLevel?: number

Optional Readonly rightTabStop

rightTabStop?: number

Optional Readonly spacing

spacing?: ISpacingProperties

Optional Readonly thematicBreak

thematicBreak?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly contextualSpacing

contextualSpacing?: boolean

Optional Readonly indent

indent?: IIndentAttributesProperties

Optional Readonly keepLines

keepLines?: boolean

Specifies that all lines of the paragraph are to be kept on a single page when possible.

+

Optional Readonly keepNext

keepNext?: boolean

Specifies that the paragraph (or at least part of it) should be rendered on the same page as the next paragraph when possible. If multiple paragraphs are to be kept together but they exceed a page, then the set of paragraphs begin on a new page and page breaks are used thereafter as needed.

+

Optional Readonly leftTabStop

leftTabStop?: number

Optional Readonly numbering

numbering?: {
    custom?: boolean;
    instance?: number;
    level: number;
    reference: string;
}

Type declaration

  • Optional Readonly custom?: boolean
  • Optional Readonly instance?: number
  • Readonly level: number
  • Readonly reference: string

Optional Readonly outlineLevel

outlineLevel?: number

Optional Readonly rightTabStop

rightTabStop?: number

Optional Readonly spacing

spacing?: ISpacingProperties

Optional Readonly thematicBreak

thematicBreak?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IRunOptions.html b/api/interfaces/IRunOptions.html index a08d321950..8beec22778 100644 --- a/api/interfaces/IRunOptions.html +++ b/api/interfaces/IRunOptions.html @@ -1,4 +1,4 @@ -IRunOptions | docx

Interface IRunOptions

interface IRunOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    break?: number;
    characterSpacing?: number;
    children?: readonly (string | FootnoteReferenceRun | FieldInstruction | Break | Begin | Separate | End | NoBreakHyphen | SoftHyphen | DayShort | MonthShort | YearShort | DayLong | MonthLong | YearLong | AnnotationReference | FootnoteReferenceElement | EndnoteReference | Separator | ContinuationSeparator | PageNumberElement | CarriageReturn | Tab | LastRenderedPageBreak | PositionalTab)[];
    color?: string;
    doubleStrike?: boolean;
    effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?: string;
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    text?: string;
    underline?: {
        color?: string;
        type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy

Properties

allCaps? +IRunOptions | docx

Interface IRunOptions

interface IRunOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    break?: number;
    characterSpacing?: number;
    children?: readonly (string | FootnoteReferenceRun | FieldInstruction | Break | Begin | Separate | End | NoBreakHyphen | SoftHyphen | DayShort | MonthShort | YearShort | DayLong | MonthLong | YearLong | AnnotationReference | FootnoteReferenceElement | EndnoteReference | Separator | ContinuationSeparator | PageNumberElement | CarriageReturn | Tab | LastRenderedPageBreak | PositionalTab)[];
    color?: string;
    doubleStrike?: boolean;
    effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?: string;
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    text?: string;
    underline?: {
        color?: string;
        type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy

Properties

allCaps? bold? boldComplexScript? border? @@ -37,4 +37,4 @@ text? underline? vanish? -

Properties

Optional Readonly allCaps

allCaps?: boolean

Optional Readonly bold

bold?: boolean

Optional Readonly boldComplexScript

boldComplexScript?: boolean

Optional Readonly border

border?: IBorderOptions

Optional Readonly break

break?: number

Optional Readonly characterSpacing

characterSpacing?: number

Optional Readonly children

children?: readonly (string | FootnoteReferenceRun | FieldInstruction | Break | Begin | Separate | End | NoBreakHyphen | SoftHyphen | DayShort | MonthShort | YearShort | DayLong | MonthLong | YearLong | AnnotationReference | FootnoteReferenceElement | EndnoteReference | Separator | ContinuationSeparator | PageNumberElement | CarriageReturn | Tab | LastRenderedPageBreak | PositionalTab)[]

Optional Readonly color

color?: string

Optional Readonly doubleStrike

doubleStrike?: boolean

Optional Readonly effect

effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle"

Optional Readonly emboss

emboss?: boolean

Optional Readonly emphasisMark

emphasisMark?: {
    type?: "dot";
}

Type declaration

  • Optional Readonly type?: "dot"

Optional Readonly font

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonly highlight

highlight?: string

Optional Readonly highlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonly imprint

imprint?: boolean

Optional Readonly italics

italics?: boolean

Optional Readonly italicsComplexScript

italicsComplexScript?: boolean

Optional Readonly kern

kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly language

language?: ILanguageOptions

Optional Readonly math

math?: boolean

Optional Readonly noProof

noProof?: boolean

Optional Readonly position

position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly revision

revision?: IRunPropertiesChangeOptions

Optional Readonly rightToLeft

rightToLeft?: boolean

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly size

size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly sizeComplexScript

sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly smallCaps

smallCaps?: boolean

Optional Readonly snapToGrid

snapToGrid?: boolean

Optional Readonly specVanish

specVanish?: boolean

Optional Readonly strike

strike?: boolean

Optional Readonly style

style?: string

Optional Readonly subScript

subScript?: boolean

Optional Readonly superScript

superScript?: boolean

Optional Readonly text

text?: string

Optional Readonly underline

underline?: {
    color?: string;
    type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
}

Type declaration

  • Optional Readonly color?: string
  • Optional Readonly type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble"

Optional Readonly vanish

vanish?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly allCaps

allCaps?: boolean

Optional Readonly bold

bold?: boolean

Optional Readonly boldComplexScript

boldComplexScript?: boolean

Optional Readonly border

border?: IBorderOptions

Optional Readonly break

break?: number

Optional Readonly characterSpacing

characterSpacing?: number

Optional Readonly children

children?: readonly (string | FootnoteReferenceRun | FieldInstruction | Break | Begin | Separate | End | NoBreakHyphen | SoftHyphen | DayShort | MonthShort | YearShort | DayLong | MonthLong | YearLong | AnnotationReference | FootnoteReferenceElement | EndnoteReference | Separator | ContinuationSeparator | PageNumberElement | CarriageReturn | Tab | LastRenderedPageBreak | PositionalTab)[]

Optional Readonly color

color?: string

Optional Readonly doubleStrike

doubleStrike?: boolean

Optional Readonly effect

effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle"

Optional Readonly emboss

emboss?: boolean

Optional Readonly emphasisMark

emphasisMark?: {
    type?: "dot";
}

Type declaration

  • Optional Readonly type?: "dot"

Optional Readonly font

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonly highlight

highlight?: string

Optional Readonly highlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonly imprint

imprint?: boolean

Optional Readonly italics

italics?: boolean

Optional Readonly italicsComplexScript

italicsComplexScript?: boolean

Optional Readonly kern

kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly language

language?: ILanguageOptions

Optional Readonly math

math?: boolean

Optional Readonly noProof

noProof?: boolean

Optional Readonly position

position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly revision

revision?: IRunPropertiesChangeOptions

Optional Readonly rightToLeft

rightToLeft?: boolean

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly size

size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly sizeComplexScript

sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly smallCaps

smallCaps?: boolean

Optional Readonly snapToGrid

snapToGrid?: boolean

Optional Readonly specVanish

specVanish?: boolean

Optional Readonly strike

strike?: boolean

Optional Readonly style

style?: string

Optional Readonly subScript

subScript?: boolean

Optional Readonly superScript

superScript?: boolean

Optional Readonly text

text?: string

Optional Readonly underline

underline?: {
    color?: string;
    type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
}

Type declaration

  • Optional Readonly color?: string
  • Optional Readonly type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble"

Optional Readonly vanish

vanish?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IRunPropertiesChangeOptions.html b/api/interfaces/IRunPropertiesChangeOptions.html index be8b38f0db..c0e8ff3d30 100644 --- a/api/interfaces/IRunPropertiesChangeOptions.html +++ b/api/interfaces/IRunPropertiesChangeOptions.html @@ -1,4 +1,4 @@ -IRunPropertiesChangeOptions | docx

Interface IRunPropertiesChangeOptions

interface IRunPropertiesChangeOptions {
    allCaps?: boolean;
    author: string;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    date: string;
    doubleStrike?: boolean;
    effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?: string;
    highlightComplexScript?: string | boolean;
    id: number;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    underline?: {
        color?: string;
        type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy

Properties

allCaps? +IRunPropertiesChangeOptions | docx

Interface IRunPropertiesChangeOptions

interface IRunPropertiesChangeOptions {
    allCaps?: boolean;
    author: string;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    date: string;
    doubleStrike?: boolean;
    effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?: string;
    highlightComplexScript?: string | boolean;
    id: number;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    underline?: {
        color?: string;
        type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy

Properties

allCaps? author bold? boldComplexScript? @@ -37,4 +37,4 @@ superScript? underline? vanish? -

Properties

Optional Readonly allCaps

allCaps?: boolean

Readonly author

author: string

Optional Readonly bold

bold?: boolean

Optional Readonly boldComplexScript

boldComplexScript?: boolean

Optional Readonly border

border?: IBorderOptions

Optional Readonly characterSpacing

characterSpacing?: number

Optional Readonly color

color?: string

Readonly date

date: string

Optional Readonly doubleStrike

doubleStrike?: boolean

Optional Readonly effect

effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle"

Optional Readonly emboss

emboss?: boolean

Optional Readonly emphasisMark

emphasisMark?: {
    type?: "dot";
}

Type declaration

  • Optional Readonly type?: "dot"

Optional Readonly font

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonly highlight

highlight?: string

Optional Readonly highlightComplexScript

highlightComplexScript?: string | boolean

Readonly id

id: number

Optional Readonly imprint

imprint?: boolean

Optional Readonly italics

italics?: boolean

Optional Readonly italicsComplexScript

italicsComplexScript?: boolean

Optional Readonly kern

kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly language

language?: ILanguageOptions

Optional Readonly math

math?: boolean

Optional Readonly noProof

noProof?: boolean

Optional Readonly position

position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly revision

revision?: IRunPropertiesChangeOptions

Optional Readonly rightToLeft

rightToLeft?: boolean

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly size

size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly sizeComplexScript

sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly smallCaps

smallCaps?: boolean

Optional Readonly snapToGrid

snapToGrid?: boolean

Optional Readonly specVanish

specVanish?: boolean

Optional Readonly strike

strike?: boolean

Optional Readonly style

style?: string

Optional Readonly subScript

subScript?: boolean

Optional Readonly superScript

superScript?: boolean

Optional Readonly underline

underline?: {
    color?: string;
    type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
}

Type declaration

  • Optional Readonly color?: string
  • Optional Readonly type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble"

Optional Readonly vanish

vanish?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly allCaps

allCaps?: boolean

Readonly author

author: string

Optional Readonly bold

bold?: boolean

Optional Readonly boldComplexScript

boldComplexScript?: boolean

Optional Readonly border

border?: IBorderOptions

Optional Readonly characterSpacing

characterSpacing?: number

Optional Readonly color

color?: string

Readonly date

date: string

Optional Readonly doubleStrike

doubleStrike?: boolean

Optional Readonly effect

effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle"

Optional Readonly emboss

emboss?: boolean

Optional Readonly emphasisMark

emphasisMark?: {
    type?: "dot";
}

Type declaration

  • Optional Readonly type?: "dot"

Optional Readonly font

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonly highlight

highlight?: string

Optional Readonly highlightComplexScript

highlightComplexScript?: string | boolean

Readonly id

id: number

Optional Readonly imprint

imprint?: boolean

Optional Readonly italics

italics?: boolean

Optional Readonly italicsComplexScript

italicsComplexScript?: boolean

Optional Readonly kern

kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly language

language?: ILanguageOptions

Optional Readonly math

math?: boolean

Optional Readonly noProof

noProof?: boolean

Optional Readonly position

position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly revision

revision?: IRunPropertiesChangeOptions

Optional Readonly rightToLeft

rightToLeft?: boolean

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly size

size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly sizeComplexScript

sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly smallCaps

smallCaps?: boolean

Optional Readonly snapToGrid

snapToGrid?: boolean

Optional Readonly specVanish

specVanish?: boolean

Optional Readonly strike

strike?: boolean

Optional Readonly style

style?: string

Optional Readonly subScript

subScript?: boolean

Optional Readonly superScript

superScript?: boolean

Optional Readonly underline

underline?: {
    color?: string;
    type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
}

Type declaration

  • Optional Readonly color?: string
  • Optional Readonly type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble"

Optional Readonly vanish

vanish?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IRunPropertiesOptions.html b/api/interfaces/IRunPropertiesOptions.html index fb4247f3ef..ea22b59cf6 100644 --- a/api/interfaces/IRunPropertiesOptions.html +++ b/api/interfaces/IRunPropertiesOptions.html @@ -1,4 +1,4 @@ -IRunPropertiesOptions | docx

Interface IRunPropertiesOptions

interface IRunPropertiesOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    doubleStrike?: boolean;
    effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?: string;
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    underline?: {
        color?: string;
        type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy

Properties

allCaps? +IRunPropertiesOptions | docx

Interface IRunPropertiesOptions

interface IRunPropertiesOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    doubleStrike?: boolean;
    effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?: string;
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    underline?: {
        color?: string;
        type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy

Properties

allCaps? bold? boldComplexScript? border? @@ -34,4 +34,4 @@ superScript? underline? vanish? -

Properties

Optional Readonly allCaps

allCaps?: boolean

Optional Readonly bold

bold?: boolean

Optional Readonly boldComplexScript

boldComplexScript?: boolean

Optional Readonly border

border?: IBorderOptions

Optional Readonly characterSpacing

characterSpacing?: number

Optional Readonly color

color?: string

Optional Readonly doubleStrike

doubleStrike?: boolean

Optional Readonly effect

effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle"

Optional Readonly emboss

emboss?: boolean

Optional Readonly emphasisMark

emphasisMark?: {
    type?: "dot";
}

Type declaration

  • Optional Readonly type?: "dot"

Optional Readonly font

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonly highlight

highlight?: string

Optional Readonly highlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonly imprint

imprint?: boolean

Optional Readonly italics

italics?: boolean

Optional Readonly italicsComplexScript

italicsComplexScript?: boolean

Optional Readonly kern

kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly language

language?: ILanguageOptions

Optional Readonly math

math?: boolean

Optional Readonly noProof

noProof?: boolean

Optional Readonly position

position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly revision

revision?: IRunPropertiesChangeOptions

Optional Readonly rightToLeft

rightToLeft?: boolean

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly size

size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly sizeComplexScript

sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly smallCaps

smallCaps?: boolean

Optional Readonly snapToGrid

snapToGrid?: boolean

Optional Readonly specVanish

specVanish?: boolean

Optional Readonly strike

strike?: boolean

Optional Readonly style

style?: string

Optional Readonly subScript

subScript?: boolean

Optional Readonly superScript

superScript?: boolean

Optional Readonly underline

underline?: {
    color?: string;
    type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
}

Type declaration

  • Optional Readonly color?: string
  • Optional Readonly type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble"

Optional Readonly vanish

vanish?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly allCaps

allCaps?: boolean

Optional Readonly bold

bold?: boolean

Optional Readonly boldComplexScript

boldComplexScript?: boolean

Optional Readonly border

border?: IBorderOptions

Optional Readonly characterSpacing

characterSpacing?: number

Optional Readonly color

color?: string

Optional Readonly doubleStrike

doubleStrike?: boolean

Optional Readonly effect

effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle"

Optional Readonly emboss

emboss?: boolean

Optional Readonly emphasisMark

emphasisMark?: {
    type?: "dot";
}

Type declaration

  • Optional Readonly type?: "dot"

Optional Readonly font

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonly highlight

highlight?: string

Optional Readonly highlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonly imprint

imprint?: boolean

Optional Readonly italics

italics?: boolean

Optional Readonly italicsComplexScript

italicsComplexScript?: boolean

Optional Readonly kern

kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly language

language?: ILanguageOptions

Optional Readonly math

math?: boolean

Optional Readonly noProof

noProof?: boolean

Optional Readonly position

position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly revision

revision?: IRunPropertiesChangeOptions

Optional Readonly rightToLeft

rightToLeft?: boolean

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly size

size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly sizeComplexScript

sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly smallCaps

smallCaps?: boolean

Optional Readonly snapToGrid

snapToGrid?: boolean

Optional Readonly specVanish

specVanish?: boolean

Optional Readonly strike

strike?: boolean

Optional Readonly style

style?: string

Optional Readonly subScript

subScript?: boolean

Optional Readonly superScript

superScript?: boolean

Optional Readonly underline

underline?: {
    color?: string;
    type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
}

Type declaration

  • Optional Readonly color?: string
  • Optional Readonly type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble"

Optional Readonly vanish

vanish?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IRunStylePropertiesOptions.html b/api/interfaces/IRunStylePropertiesOptions.html index 0716f2956f..a2d9b235b7 100644 --- a/api/interfaces/IRunStylePropertiesOptions.html +++ b/api/interfaces/IRunStylePropertiesOptions.html @@ -1,4 +1,4 @@ -IRunStylePropertiesOptions | docx

Interface IRunStylePropertiesOptions

interface IRunStylePropertiesOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    doubleStrike?: boolean;
    effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?: string;
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    subScript?: boolean;
    superScript?: boolean;
    underline?: {
        color?: string;
        type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy

Properties

allCaps? +IRunStylePropertiesOptions | docx

Interface IRunStylePropertiesOptions

interface IRunStylePropertiesOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    doubleStrike?: boolean;
    effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?: string;
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    subScript?: boolean;
    superScript?: boolean;
    underline?: {
        color?: string;
        type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy

Properties

allCaps? bold? boldComplexScript? border? @@ -33,4 +33,4 @@ superScript? underline? vanish? -

Properties

Optional Readonly allCaps

allCaps?: boolean

Optional Readonly bold

bold?: boolean

Optional Readonly boldComplexScript

boldComplexScript?: boolean

Optional Readonly border

border?: IBorderOptions

Optional Readonly characterSpacing

characterSpacing?: number

Optional Readonly color

color?: string

Optional Readonly doubleStrike

doubleStrike?: boolean

Optional Readonly effect

effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle"

Optional Readonly emboss

emboss?: boolean

Optional Readonly emphasisMark

emphasisMark?: {
    type?: "dot";
}

Type declaration

  • Optional Readonly type?: "dot"

Optional Readonly font

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonly highlight

highlight?: string

Optional Readonly highlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonly imprint

imprint?: boolean

Optional Readonly italics

italics?: boolean

Optional Readonly italicsComplexScript

italicsComplexScript?: boolean

Optional Readonly kern

kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly language

language?: ILanguageOptions

Optional Readonly math

math?: boolean

Optional Readonly noProof

noProof?: boolean

Optional Readonly position

position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly revision

revision?: IRunPropertiesChangeOptions

Optional Readonly rightToLeft

rightToLeft?: boolean

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly size

size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly sizeComplexScript

sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly smallCaps

smallCaps?: boolean

Optional Readonly snapToGrid

snapToGrid?: boolean

Optional Readonly specVanish

specVanish?: boolean

Optional Readonly strike

strike?: boolean

Optional Readonly subScript

subScript?: boolean

Optional Readonly superScript

superScript?: boolean

Optional Readonly underline

underline?: {
    color?: string;
    type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
}

Type declaration

  • Optional Readonly color?: string
  • Optional Readonly type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble"

Optional Readonly vanish

vanish?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly allCaps

allCaps?: boolean

Optional Readonly bold

bold?: boolean

Optional Readonly boldComplexScript

boldComplexScript?: boolean

Optional Readonly border

border?: IBorderOptions

Optional Readonly characterSpacing

characterSpacing?: number

Optional Readonly color

color?: string

Optional Readonly doubleStrike

doubleStrike?: boolean

Optional Readonly effect

effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle"

Optional Readonly emboss

emboss?: boolean

Optional Readonly emphasisMark

emphasisMark?: {
    type?: "dot";
}

Type declaration

  • Optional Readonly type?: "dot"

Optional Readonly font

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonly highlight

highlight?: string

Optional Readonly highlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonly imprint

imprint?: boolean

Optional Readonly italics

italics?: boolean

Optional Readonly italicsComplexScript

italicsComplexScript?: boolean

Optional Readonly kern

kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly language

language?: ILanguageOptions

Optional Readonly math

math?: boolean

Optional Readonly noProof

noProof?: boolean

Optional Readonly position

position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly revision

revision?: IRunPropertiesChangeOptions

Optional Readonly rightToLeft

rightToLeft?: boolean

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly size

size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly sizeComplexScript

sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly smallCaps

smallCaps?: boolean

Optional Readonly snapToGrid

snapToGrid?: boolean

Optional Readonly specVanish

specVanish?: boolean

Optional Readonly strike

strike?: boolean

Optional Readonly subScript

subScript?: boolean

Optional Readonly superScript

superScript?: boolean

Optional Readonly underline

underline?: {
    color?: string;
    type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
}

Type declaration

  • Optional Readonly color?: string
  • Optional Readonly type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble"

Optional Readonly vanish

vanish?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ISectionOptions.html b/api/interfaces/ISectionOptions.html index 68e8af58c3..c3dcca4e11 100644 --- a/api/interfaces/ISectionOptions.html +++ b/api/interfaces/ISectionOptions.html @@ -1,5 +1,5 @@ -ISectionOptions | docx

Interface ISectionOptions

interface ISectionOptions {
    children: readonly FileChild[];
    footers?: {
        default?: Footer;
        even?: Footer;
        first?: Footer;
    };
    headers?: {
        default?: Header;
        even?: Header;
        first?: Header;
    };
    properties?: ISectionPropertiesOptions;
}

Properties

children +ISectionOptions | docx

Interface ISectionOptions

interface ISectionOptions {
    children: readonly FileChild[];
    footers?: {
        default?: Footer;
        even?: Footer;
        first?: Footer;
    };
    headers?: {
        default?: Header;
        even?: Header;
        first?: Header;
    };
    properties?: ISectionPropertiesOptions;
}

Properties

children footers? headers? properties? -

Properties

Readonly children

children: readonly FileChild[]

Optional Readonly footers

footers?: {
    default?: Footer;
    even?: Footer;
    first?: Footer;
}

Type declaration

  • Optional Readonly default?: Footer
  • Optional Readonly even?: Footer
  • Optional Readonly first?: Footer

Optional Readonly headers

headers?: {
    default?: Header;
    even?: Header;
    first?: Header;
}

Type declaration

  • Optional Readonly default?: Header
  • Optional Readonly even?: Header
  • Optional Readonly first?: Header

Optional Readonly properties

properties?: ISectionPropertiesOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly children

children: readonly FileChild[]

Optional Readonly footers

footers?: {
    default?: Footer;
    even?: Footer;
    first?: Footer;
}

Type declaration

  • Optional Readonly default?: Footer
  • Optional Readonly even?: Footer
  • Optional Readonly first?: Footer

Optional Readonly headers

headers?: {
    default?: Header;
    even?: Header;
    first?: Header;
}

Type declaration

  • Optional Readonly default?: Header
  • Optional Readonly even?: Header
  • Optional Readonly first?: Header

Optional Readonly properties

properties?: ISectionPropertiesOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ISectionPropertiesOptions.html b/api/interfaces/ISectionPropertiesOptions.html index 91a0b71fe9..17832ffcf6 100644 --- a/api/interfaces/ISectionPropertiesOptions.html +++ b/api/interfaces/ISectionPropertiesOptions.html @@ -1,4 +1,4 @@ -ISectionPropertiesOptions | docx

Interface ISectionPropertiesOptions

interface ISectionPropertiesOptions {
    column?: IColumnsAttributes;
    footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>;
    grid?: IDocGridAttributesProperties;
    headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>;
    lineNumbers?: ILineNumberAttributes;
    page?: {
        borders?: IPageBordersOptions;
        margin?: IPageMarginAttributes;
        pageNumbers?: IPageNumberTypeAttributes;
        size?: IPageSizeAttributes;
        textDirection?: "lrTb" | "tbRl";
    };
    titlePage?: boolean;
    type?: "continuous" | "nextPage" | "nextColumn" | "evenPage" | "oddPage";
    verticalAlign?: "bottom" | "center" | "top";
}

Properties

column? +ISectionPropertiesOptions | docx

Interface ISectionPropertiesOptions

interface ISectionPropertiesOptions {
    column?: IColumnsAttributes;
    footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>;
    grid?: IDocGridAttributesProperties;
    headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>;
    lineNumbers?: ILineNumberAttributes;
    page?: {
        borders?: IPageBordersOptions;
        margin?: IPageMarginAttributes;
        pageNumbers?: IPageNumberTypeAttributes;
        size?: IPageSizeAttributes;
        textDirection?: "lrTb" | "tbRl";
    };
    titlePage?: boolean;
    type?: "continuous" | "nextPage" | "nextColumn" | "evenPage" | "oddPage";
    verticalAlign?: "bottom" | "center" | "top";
}

Properties

column? footerWrapperGroup? grid? headerWrapperGroup? @@ -7,4 +7,4 @@ titlePage? type? verticalAlign? -

Properties

Optional Readonly column

column?: IColumnsAttributes

Optional Readonly footerWrapperGroup

footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>

Optional Readonly grid

grid?: IDocGridAttributesProperties

Optional Readonly headerWrapperGroup

headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>

Optional Readonly lineNumbers

lineNumbers?: ILineNumberAttributes

Optional Readonly page

page?: {
    borders?: IPageBordersOptions;
    margin?: IPageMarginAttributes;
    pageNumbers?: IPageNumberTypeAttributes;
    size?: IPageSizeAttributes;
    textDirection?: "lrTb" | "tbRl";
}

Type declaration

Optional Readonly titlePage

titlePage?: boolean

Optional Readonly type

type?: "continuous" | "nextPage" | "nextColumn" | "evenPage" | "oddPage"

Optional Readonly verticalAlign

verticalAlign?: "bottom" | "center" | "top"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly column

column?: IColumnsAttributes

Optional Readonly footerWrapperGroup

footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>

Optional Readonly grid

grid?: IDocGridAttributesProperties

Optional Readonly headerWrapperGroup

headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>

Optional Readonly lineNumbers

lineNumbers?: ILineNumberAttributes

Optional Readonly page

page?: {
    borders?: IPageBordersOptions;
    margin?: IPageMarginAttributes;
    pageNumbers?: IPageNumberTypeAttributes;
    size?: IPageSizeAttributes;
    textDirection?: "lrTb" | "tbRl";
}

Type declaration

Optional Readonly titlePage

titlePage?: boolean

Optional Readonly type

type?: "continuous" | "nextPage" | "nextColumn" | "evenPage" | "oddPage"

Optional Readonly verticalAlign

verticalAlign?: "bottom" | "center" | "top"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IShadingAttributesProperties.html b/api/interfaces/IShadingAttributesProperties.html index 4a79f734ae..ea57de7eec 100644 --- a/api/interfaces/IShadingAttributesProperties.html +++ b/api/interfaces/IShadingAttributesProperties.html @@ -1,4 +1,4 @@ -IShadingAttributesProperties | docx

Interface IShadingAttributesProperties

interface IShadingAttributesProperties {
    color?: string;
    fill?: string;
    type?: "clear" | "diagCross" | "diagStripe" | "horzCross" | "horzStripe" | "nil" | "pct5" | "pct10" | "pct12" | "pct15" | "pct20" | "pct25" | "pct30" | "pct35" | "pct37" | "pct40" | "pct45" | "pct50" | "pct55" | "pct60" | "pct62" | "pct65" | "pct70" | "pct75" | "pct80" | "pct85" | "pct87" | "pct90" | "pct95" | "reverseDiagStripe" | "solid" | "thinDiagCross" | "thinDiagStripe" | "thinHorzCross" | "thinReverseDiagStripe" | "thinVertStripe" | "vertStripe";
}

Properties

color? +IShadingAttributesProperties | docx

Interface IShadingAttributesProperties

interface IShadingAttributesProperties {
    color?: string;
    fill?: string;
    type?: "clear" | "diagCross" | "diagStripe" | "horzCross" | "horzStripe" | "nil" | "pct5" | "pct10" | "pct12" | "pct15" | "pct20" | "pct25" | "pct30" | "pct35" | "pct37" | "pct40" | "pct45" | "pct50" | "pct55" | "pct60" | "pct62" | "pct65" | "pct70" | "pct75" | "pct80" | "pct85" | "pct87" | "pct90" | "pct95" | "reverseDiagStripe" | "solid" | "thinDiagCross" | "thinDiagStripe" | "thinHorzCross" | "thinReverseDiagStripe" | "thinVertStripe" | "vertStripe";
}

Properties

color? fill? type? -

Properties

Optional Readonly color

color?: string

Optional Readonly fill

fill?: string

Optional Readonly type

type?: "clear" | "diagCross" | "diagStripe" | "horzCross" | "horzStripe" | "nil" | "pct5" | "pct10" | "pct12" | "pct15" | "pct20" | "pct25" | "pct30" | "pct35" | "pct37" | "pct40" | "pct45" | "pct50" | "pct55" | "pct60" | "pct62" | "pct65" | "pct70" | "pct75" | "pct80" | "pct85" | "pct87" | "pct90" | "pct95" | "reverseDiagStripe" | "solid" | "thinDiagCross" | "thinDiagStripe" | "thinHorzCross" | "thinReverseDiagStripe" | "thinVertStripe" | "vertStripe"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly color

color?: string

Optional Readonly fill

fill?: string

Optional Readonly type

type?: "clear" | "diagCross" | "diagStripe" | "horzCross" | "horzStripe" | "nil" | "pct5" | "pct10" | "pct12" | "pct15" | "pct20" | "pct25" | "pct30" | "pct35" | "pct37" | "pct40" | "pct45" | "pct50" | "pct55" | "pct60" | "pct62" | "pct65" | "pct70" | "pct75" | "pct80" | "pct85" | "pct87" | "pct90" | "pct95" | "reverseDiagStripe" | "solid" | "thinDiagCross" | "thinDiagStripe" | "thinHorzCross" | "thinReverseDiagStripe" | "thinVertStripe" | "vertStripe"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ISpacingProperties.html b/api/interfaces/ISpacingProperties.html index 1f456e014b..6b3c947432 100644 --- a/api/interfaces/ISpacingProperties.html +++ b/api/interfaces/ISpacingProperties.html @@ -1,7 +1,7 @@ -ISpacingProperties | docx

Interface ISpacingProperties

interface ISpacingProperties {
    after?: number;
    afterAutoSpacing?: boolean;
    before?: number;
    beforeAutoSpacing?: boolean;
    line?: number;
    lineRule?: "auto" | "atLeast" | "exact" | "exactly";
}

Properties

after? +ISpacingProperties | docx

Interface ISpacingProperties

interface ISpacingProperties {
    after?: number;
    afterAutoSpacing?: boolean;
    before?: number;
    beforeAutoSpacing?: boolean;
    line?: number;
    lineRule?: "auto" | "atLeast" | "exact" | "exactly";
}

Properties

after? afterAutoSpacing? before? beforeAutoSpacing? line? lineRule? -

Properties

Optional Readonly after

after?: number

Optional Readonly afterAutoSpacing

afterAutoSpacing?: boolean

Optional Readonly before

before?: number

Optional Readonly beforeAutoSpacing

beforeAutoSpacing?: boolean

Optional Readonly line

line?: number

Optional Readonly lineRule

lineRule?: "auto" | "atLeast" | "exact" | "exactly"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly after

after?: number

Optional Readonly afterAutoSpacing

afterAutoSpacing?: boolean

Optional Readonly before

before?: number

Optional Readonly beforeAutoSpacing

beforeAutoSpacing?: boolean

Optional Readonly line

line?: number

Optional Readonly lineRule

lineRule?: "auto" | "atLeast" | "exact" | "exactly"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IStylesOptions.html b/api/interfaces/IStylesOptions.html index f8500e366e..3d8bed9368 100644 --- a/api/interfaces/IStylesOptions.html +++ b/api/interfaces/IStylesOptions.html @@ -1,6 +1,6 @@ -IStylesOptions | docx

Interface IStylesOptions

interface IStylesOptions {
    characterStyles?: readonly ICharacterStyleOptions[];
    default?: IDefaultStylesOptions;
    importedStyles?: readonly (XmlComponent | StyleForParagraph | StyleForCharacter | ImportedXmlComponent)[];
    initialStyles?: BaseXmlComponent;
    paragraphStyles?: readonly IParagraphStyleOptions[];
}

Properties

characterStyles? +IStylesOptions | docx

Interface IStylesOptions

interface IStylesOptions {
    characterStyles?: readonly ICharacterStyleOptions[];
    default?: IDefaultStylesOptions;
    importedStyles?: readonly (XmlComponent | StyleForParagraph | StyleForCharacter | ImportedXmlComponent)[];
    initialStyles?: BaseXmlComponent;
    paragraphStyles?: readonly IParagraphStyleOptions[];
}

Properties

characterStyles? default? importedStyles? initialStyles? paragraphStyles? -

Properties

Optional Readonly characterStyles

characterStyles?: readonly ICharacterStyleOptions[]

Optional Readonly default

default?: IDefaultStylesOptions

Optional Readonly importedStyles

importedStyles?: readonly (XmlComponent | StyleForParagraph | StyleForCharacter | ImportedXmlComponent)[]

Optional Readonly initialStyles

initialStyles?: BaseXmlComponent

Optional Readonly paragraphStyles

paragraphStyles?: readonly IParagraphStyleOptions[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly characterStyles

characterStyles?: readonly ICharacterStyleOptions[]

Optional Readonly default

default?: IDefaultStylesOptions

Optional Readonly importedStyles

importedStyles?: readonly (XmlComponent | StyleForParagraph | StyleForCharacter | ImportedXmlComponent)[]

Optional Readonly initialStyles

initialStyles?: BaseXmlComponent

Optional Readonly paragraphStyles

paragraphStyles?: readonly IParagraphStyleOptions[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ISymbolRunOptions.html b/api/interfaces/ISymbolRunOptions.html index 6eb28d210e..301602936f 100644 --- a/api/interfaces/ISymbolRunOptions.html +++ b/api/interfaces/ISymbolRunOptions.html @@ -1,4 +1,4 @@ -ISymbolRunOptions | docx

Interface ISymbolRunOptions

interface ISymbolRunOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    break?: number;
    char: string;
    characterSpacing?: number;
    children?: readonly (string | FootnoteReferenceRun | FieldInstruction | Break | Begin | Separate | End | NoBreakHyphen | SoftHyphen | DayShort | MonthShort | YearShort | DayLong | MonthLong | YearLong | AnnotationReference | FootnoteReferenceElement | EndnoteReference | Separator | ContinuationSeparator | PageNumberElement | CarriageReturn | Tab | LastRenderedPageBreak | PositionalTab)[];
    color?: string;
    doubleStrike?: boolean;
    effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?: string;
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    symbolfont?: string;
    text?: string;
    underline?: {
        color?: string;
        type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy

Properties

allCaps? +ISymbolRunOptions | docx

Interface ISymbolRunOptions

interface ISymbolRunOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    break?: number;
    char: string;
    characterSpacing?: number;
    children?: readonly (string | FootnoteReferenceRun | FieldInstruction | Break | Begin | Separate | End | NoBreakHyphen | SoftHyphen | DayShort | MonthShort | YearShort | DayLong | MonthLong | YearLong | AnnotationReference | FootnoteReferenceElement | EndnoteReference | Separator | ContinuationSeparator | PageNumberElement | CarriageReturn | Tab | LastRenderedPageBreak | PositionalTab)[];
    color?: string;
    doubleStrike?: boolean;
    effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?: string;
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    symbolfont?: string;
    text?: string;
    underline?: {
        color?: string;
        type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy

Properties

allCaps? bold? boldComplexScript? border? @@ -39,4 +39,4 @@ text? underline? vanish? -

Properties

Optional Readonly allCaps

allCaps?: boolean

Optional Readonly bold

bold?: boolean

Optional Readonly boldComplexScript

boldComplexScript?: boolean

Optional Readonly border

border?: IBorderOptions

Optional Readonly break

break?: number

Readonly char

char: string

Optional Readonly characterSpacing

characterSpacing?: number

Optional Readonly children

children?: readonly (string | FootnoteReferenceRun | FieldInstruction | Break | Begin | Separate | End | NoBreakHyphen | SoftHyphen | DayShort | MonthShort | YearShort | DayLong | MonthLong | YearLong | AnnotationReference | FootnoteReferenceElement | EndnoteReference | Separator | ContinuationSeparator | PageNumberElement | CarriageReturn | Tab | LastRenderedPageBreak | PositionalTab)[]

Optional Readonly color

color?: string

Optional Readonly doubleStrike

doubleStrike?: boolean

Optional Readonly effect

effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle"

Optional Readonly emboss

emboss?: boolean

Optional Readonly emphasisMark

emphasisMark?: {
    type?: "dot";
}

Type declaration

  • Optional Readonly type?: "dot"

Optional Readonly font

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonly highlight

highlight?: string

Optional Readonly highlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonly imprint

imprint?: boolean

Optional Readonly italics

italics?: boolean

Optional Readonly italicsComplexScript

italicsComplexScript?: boolean

Optional Readonly kern

kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly language

language?: ILanguageOptions

Optional Readonly math

math?: boolean

Optional Readonly noProof

noProof?: boolean

Optional Readonly position

position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly revision

revision?: IRunPropertiesChangeOptions

Optional Readonly rightToLeft

rightToLeft?: boolean

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly size

size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly sizeComplexScript

sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly smallCaps

smallCaps?: boolean

Optional Readonly snapToGrid

snapToGrid?: boolean

Optional Readonly specVanish

specVanish?: boolean

Optional Readonly strike

strike?: boolean

Optional Readonly style

style?: string

Optional Readonly subScript

subScript?: boolean

Optional Readonly superScript

superScript?: boolean

Optional Readonly symbolfont

symbolfont?: string

Optional Readonly text

text?: string

Optional Readonly underline

underline?: {
    color?: string;
    type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
}

Type declaration

  • Optional Readonly color?: string
  • Optional Readonly type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble"

Optional Readonly vanish

vanish?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly allCaps

allCaps?: boolean

Optional Readonly bold

bold?: boolean

Optional Readonly boldComplexScript

boldComplexScript?: boolean

Optional Readonly border

border?: IBorderOptions

Optional Readonly break

break?: number

Readonly char

char: string

Optional Readonly characterSpacing

characterSpacing?: number

Optional Readonly children

children?: readonly (string | FootnoteReferenceRun | FieldInstruction | Break | Begin | Separate | End | NoBreakHyphen | SoftHyphen | DayShort | MonthShort | YearShort | DayLong | MonthLong | YearLong | AnnotationReference | FootnoteReferenceElement | EndnoteReference | Separator | ContinuationSeparator | PageNumberElement | CarriageReturn | Tab | LastRenderedPageBreak | PositionalTab)[]

Optional Readonly color

color?: string

Optional Readonly doubleStrike

doubleStrike?: boolean

Optional Readonly effect

effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle"

Optional Readonly emboss

emboss?: boolean

Optional Readonly emphasisMark

emphasisMark?: {
    type?: "dot";
}

Type declaration

  • Optional Readonly type?: "dot"

Optional Readonly font

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonly highlight

highlight?: string

Optional Readonly highlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonly imprint

imprint?: boolean

Optional Readonly italics

italics?: boolean

Optional Readonly italicsComplexScript

italicsComplexScript?: boolean

Optional Readonly kern

kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly language

language?: ILanguageOptions

Optional Readonly math

math?: boolean

Optional Readonly noProof

noProof?: boolean

Optional Readonly position

position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly revision

revision?: IRunPropertiesChangeOptions

Optional Readonly rightToLeft

rightToLeft?: boolean

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly size

size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly sizeComplexScript

sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly smallCaps

smallCaps?: boolean

Optional Readonly snapToGrid

snapToGrid?: boolean

Optional Readonly specVanish

specVanish?: boolean

Optional Readonly strike

strike?: boolean

Optional Readonly style

style?: string

Optional Readonly subScript

subScript?: boolean

Optional Readonly superScript

superScript?: boolean

Optional Readonly symbolfont

symbolfont?: string

Optional Readonly text

text?: string

Optional Readonly underline

underline?: {
    color?: string;
    type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
}

Type declaration

  • Optional Readonly color?: string
  • Optional Readonly type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble"

Optional Readonly vanish

vanish?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ITableBordersOptions.html b/api/interfaces/ITableBordersOptions.html index bf1528e28f..9dfefa9feb 100644 --- a/api/interfaces/ITableBordersOptions.html +++ b/api/interfaces/ITableBordersOptions.html @@ -1,7 +1,7 @@ -ITableBordersOptions | docx

Interface ITableBordersOptions

interface ITableBordersOptions {
    bottom?: IBorderOptions;
    insideHorizontal?: IBorderOptions;
    insideVertical?: IBorderOptions;
    left?: IBorderOptions;
    right?: IBorderOptions;
    top?: IBorderOptions;
}

Properties

bottom? +ITableBordersOptions | docx

Interface ITableBordersOptions

interface ITableBordersOptions {
    bottom?: IBorderOptions;
    insideHorizontal?: IBorderOptions;
    insideVertical?: IBorderOptions;
    left?: IBorderOptions;
    right?: IBorderOptions;
    top?: IBorderOptions;
}

Properties

bottom? insideHorizontal? insideVertical? left? right? top? -

Properties

Optional Readonly bottom

bottom?: IBorderOptions

Optional Readonly insideHorizontal

insideHorizontal?: IBorderOptions

Optional Readonly insideVertical

insideVertical?: IBorderOptions

Optional Readonly left

left?: IBorderOptions

Optional Readonly right

right?: IBorderOptions

Optional Readonly top

top?: IBorderOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly bottom

bottom?: IBorderOptions

Optional Readonly insideHorizontal

insideHorizontal?: IBorderOptions

Optional Readonly insideVertical

insideVertical?: IBorderOptions

Optional Readonly left

left?: IBorderOptions

Optional Readonly right

right?: IBorderOptions

Optional Readonly top

top?: IBorderOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ITableCellBorders.html b/api/interfaces/ITableCellBorders.html index cacc602590..3461217525 100644 --- a/api/interfaces/ITableCellBorders.html +++ b/api/interfaces/ITableCellBorders.html @@ -1,7 +1,7 @@ -ITableCellBorders | docx

Interface ITableCellBorders

interface ITableCellBorders {
    bottom?: IBorderOptions;
    end?: IBorderOptions;
    left?: IBorderOptions;
    right?: IBorderOptions;
    start?: IBorderOptions;
    top?: IBorderOptions;
}

Properties

bottom? +ITableCellBorders | docx

Interface ITableCellBorders

interface ITableCellBorders {
    bottom?: IBorderOptions;
    end?: IBorderOptions;
    left?: IBorderOptions;
    right?: IBorderOptions;
    start?: IBorderOptions;
    top?: IBorderOptions;
}

Properties

bottom? end? left? right? start? top? -

Properties

Optional Readonly bottom

bottom?: IBorderOptions

Optional Readonly end

end?: IBorderOptions

Optional Readonly left

left?: IBorderOptions

Optional Readonly right

right?: IBorderOptions

Optional Readonly start

start?: IBorderOptions

Optional Readonly top

top?: IBorderOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly bottom

bottom?: IBorderOptions

Optional Readonly end

end?: IBorderOptions

Optional Readonly left

left?: IBorderOptions

Optional Readonly right

right?: IBorderOptions

Optional Readonly start

start?: IBorderOptions

Optional Readonly top

top?: IBorderOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ITableCellOptions.html b/api/interfaces/ITableCellOptions.html index 8f10bd253c..40b125d724 100644 --- a/api/interfaces/ITableCellOptions.html +++ b/api/interfaces/ITableCellOptions.html @@ -1,4 +1,4 @@ -ITableCellOptions | docx

Interface ITableCellOptions

interface ITableCellOptions {
    borders?: ITableCellBorders;
    children: readonly (Paragraph | Table)[];
    columnSpan?: number;
    margins?: ITableCellMarginOptions;
    rowSpan?: number;
    shading?: IShadingAttributesProperties;
    textDirection?: "btLr" | "lrTb" | "tbRl";
    verticalAlign?: "bottom" | "center" | "top";
    verticalMerge?: "continue" | "restart";
    width?: ITableWidthProperties;
}

Hierarchy

  • ITableCellPropertiesOptions
    • ITableCellOptions

Properties

borders? +ITableCellOptions | docx

Interface ITableCellOptions

interface ITableCellOptions {
    borders?: ITableCellBorders;
    children: readonly (Paragraph | Table)[];
    columnSpan?: number;
    margins?: ITableCellMarginOptions;
    rowSpan?: number;
    shading?: IShadingAttributesProperties;
    textDirection?: "btLr" | "lrTb" | "tbRl";
    verticalAlign?: "bottom" | "center" | "top";
    verticalMerge?: "continue" | "restart";
    width?: ITableWidthProperties;
}

Hierarchy

  • ITableCellPropertiesOptions
    • ITableCellOptions

Properties

borders? children columnSpan? margins? @@ -8,4 +8,4 @@ verticalAlign? verticalMerge? width? -

Properties

Optional Readonly borders

borders?: ITableCellBorders

Readonly children

children: readonly (Paragraph | Table)[]

Optional Readonly columnSpan

columnSpan?: number

Optional Readonly margins

margins?: ITableCellMarginOptions

Optional Readonly rowSpan

rowSpan?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly textDirection

textDirection?: "btLr" | "lrTb" | "tbRl"

Optional Readonly verticalAlign

verticalAlign?: "bottom" | "center" | "top"

Optional Readonly verticalMerge

verticalMerge?: "continue" | "restart"

Optional Readonly width

width?: ITableWidthProperties

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly borders

borders?: ITableCellBorders

Readonly children

children: readonly (Paragraph | Table)[]

Optional Readonly columnSpan

columnSpan?: number

Optional Readonly margins

margins?: ITableCellMarginOptions

Optional Readonly rowSpan

rowSpan?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly textDirection

textDirection?: "btLr" | "lrTb" | "tbRl"

Optional Readonly verticalAlign

verticalAlign?: "bottom" | "center" | "top"

Optional Readonly verticalMerge

verticalMerge?: "continue" | "restart"

Optional Readonly width

width?: ITableWidthProperties

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ITableOfContentsOptions.html b/api/interfaces/ITableOfContentsOptions.html index 10952c45cd..46f6016271 100644 --- a/api/interfaces/ITableOfContentsOptions.html +++ b/api/interfaces/ITableOfContentsOptions.html @@ -3,7 +3,7 @@ Part 1 - Page 1251

Short Guide: http://officeopenxml.com/WPtableOfContents.php

-
interface ITableOfContentsOptions {
    captionLabel?: string;
    captionLabelIncludingNumbers?: string;
    entriesFromBookmark?: string;
    entryAndPageNumberSeparator?: string;
    headingStyleRange?: string;
    hideTabAndPageNumbersInWebView?: boolean;
    hyperlink?: boolean;
    pageNumbersEntryLevelsRange?: string;
    preserveNewLineInEntries?: boolean;
    preserveTabInEntries?: boolean;
    seqFieldIdentifierForPrefix?: string;
    sequenceAndPageNumbersSeparator?: string;
    stylesWithLevels?: readonly StyleLevel[];
    tcFieldIdentifier?: string;
    tcFieldLevelRange?: string;
    useAppliedParagraphOutlineLevel?: boolean;
}

Properties

captionLabel? +
interface ITableOfContentsOptions {
    captionLabel?: string;
    captionLabelIncludingNumbers?: string;
    entriesFromBookmark?: string;
    entryAndPageNumberSeparator?: string;
    headingStyleRange?: string;
    hideTabAndPageNumbersInWebView?: boolean;
    hyperlink?: boolean;
    pageNumbersEntryLevelsRange?: string;
    preserveNewLineInEntries?: boolean;
    preserveTabInEntries?: boolean;
    seqFieldIdentifierForPrefix?: string;
    sequenceAndPageNumbersSeparator?: string;
    stylesWithLevels?: readonly StyleLevel[];
    tcFieldIdentifier?: string;
    tcFieldLevelRange?: string;
    useAppliedParagraphOutlineLevel?: boolean;
}

Properties

captionLabel? captionLabelIncludingNumbers? entriesFromBookmark? entryAndPageNumberSeparator? @@ -22,40 +22,40 @@ Part 1 - Page 1251

Properties

Optional Readonly captionLabel

captionLabel?: string

\a option - Includes captioned items, but omits caption labels and numbers. The identifier designated by text in this switch's field-argument corresponds to the caption label. Use captionLabelIncludingNumbers (\c) to build a table of captions with labels and numbers.

-

Optional Readonly captionLabelIncludingNumbers

captionLabelIncludingNumbers?: string

\c option - Includes figures, tables, charts, and other items that are numbered +

Optional Readonly captionLabelIncludingNumbers

captionLabelIncludingNumbers?: string

\c option - Includes figures, tables, charts, and other items that are numbered by a SEQ field (§17.16.5.56). The sequence identifier designated by text in this switch's field-argument, which corresponds to the caption label, shall match the identifier in the corresponding SEQ field.

-

Optional Readonly entriesFromBookmark

entriesFromBookmark?: string

\b option - Includes entries only from the portion of the document marked by +

Optional Readonly entriesFromBookmark

entriesFromBookmark?: string

\b option - Includes entries only from the portion of the document marked by the bookmark named by text in this switch's field-argument.

-

Optional Readonly entryAndPageNumberSeparator

entryAndPageNumberSeparator?: string

\p option - Text in this switch's field-argument specifies a sequence of characters +

Optional Readonly entryAndPageNumberSeparator

entryAndPageNumberSeparator?: string

\p option - Text in this switch's field-argument specifies a sequence of characters that separate an entry and its page number. The default is a tab with leader dots.

-

Optional Readonly headingStyleRange

headingStyleRange?: string

\o option - Uses paragraphs formatted with all or the specified range of builtin +

Optional Readonly headingStyleRange

headingStyleRange?: string

\o option - Uses paragraphs formatted with all or the specified range of builtin heading styles. Headings in a style range are specified by text in this switch's field-argument using the notation specified as for \l, where each integer corresponds 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.

-

Optional Readonly hideTabAndPageNumbersInWebView

hideTabAndPageNumbersInWebView?: boolean

\z Hides tab leader and page numbers in web page view (§17.18.102).

-

Optional Readonly hyperlink

hyperlink?: boolean

\h option - Makes the table of contents entries hyperlinks.

-

Optional Readonly pageNumbersEntryLevelsRange

pageNumbersEntryLevelsRange?: string

\n option - Without field-argument, omits page numbers from the table of contents. +

Optional Readonly hideTabAndPageNumbersInWebView

hideTabAndPageNumbersInWebView?: boolean

\z Hides tab leader and page numbers in web page view (§17.18.102).

+

Optional Readonly hyperlink

hyperlink?: boolean

\h option - Makes the table of contents entries hyperlinks.

+

Optional Readonly pageNumbersEntryLevelsRange

pageNumbersEntryLevelsRange?: string

\n option - Without field-argument, omits page numbers from the table of contents. Page numbers are omitted from all levels unless a range of entry levels is specified by text in this switch's field-argument. A range is specified as for \l.

-

Optional Readonly preserveNewLineInEntries

preserveNewLineInEntries?: boolean

\x Preserves newline characters within table entries.

-

Optional Readonly preserveTabInEntries

preserveTabInEntries?: boolean

\w Preserves tab entries within table entries.

-

Optional Readonly seqFieldIdentifierForPrefix

seqFieldIdentifierForPrefix?: string

\s option - For entries numbered with a SEQ field (§17.16.5.56), adds a prefix to the page number. +

Optional Readonly preserveNewLineInEntries

preserveNewLineInEntries?: boolean

\x Preserves newline characters within table entries.

+

Optional Readonly preserveTabInEntries

preserveTabInEntries?: boolean

\w Preserves tab entries within table entries.

+

Optional Readonly seqFieldIdentifierForPrefix

seqFieldIdentifierForPrefix?: string

\s option - For entries numbered with a SEQ field (§17.16.5.56), adds a prefix to the page number. The prefix depends on the type of entry. text in this switch's field-argument shall match the identifier in the SEQ field.

-

Optional Readonly sequenceAndPageNumbersSeparator

sequenceAndPageNumbersSeparator?: string

\d option - When used with \s, the text in this switch's field-argument defines +

Optional Readonly sequenceAndPageNumbersSeparator

sequenceAndPageNumbersSeparator?: string

\d option - When used with \s, the text in this switch's field-argument defines the separator between sequence and page numbers. The default separator is a hyphen (-).

-

Optional Readonly stylesWithLevels

stylesWithLevels?: readonly StyleLevel[]

\t field-argument Uses paragraphs formatted with styles other than the built-in heading styles. +

Optional Readonly stylesWithLevels

stylesWithLevels?: readonly StyleLevel[]

\t field-argument Uses paragraphs formatted with styles other than the built-in heading styles. Text in this switch's field-argument specifies those styles as a set of comma-separated doublets, with each doublet being a comma-separated set of style name and table of content level. \t can be combined with \o.

-

Optional Readonly tcFieldIdentifier

tcFieldIdentifier?: string

\f option - Includes only those TC fields whose identifier exactly matches the +

Optional Readonly tcFieldIdentifier

tcFieldIdentifier?: string

\f option - Includes only those TC fields whose identifier exactly matches the text in this switch's field-argument (which is typically a letter).

-

Optional Readonly tcFieldLevelRange

tcFieldLevelRange?: string

\l option - Includes TC fields that assign entries to one of the levels specified +

Optional Readonly tcFieldLevelRange

tcFieldLevelRange?: string

\l option - Includes TC fields that assign entries to one of the levels specified by text in this switch's field-argument as a range having the form startLevel-endLevel, where startLevel and endLevel are integers, and startLevel has a value equal-to or less-than endLevel. TC fields that assign entries to lower levels are skipped.

-

Optional Readonly useAppliedParagraphOutlineLevel

useAppliedParagraphOutlineLevel?: boolean

\u Uses the applied paragraph outline level.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional Readonly useAppliedParagraphOutlineLevel

useAppliedParagraphOutlineLevel?: boolean

\u Uses the applied paragraph outline level.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ITableOptions.html b/api/interfaces/ITableOptions.html index 99a289eba0..345585d6a8 100644 --- a/api/interfaces/ITableOptions.html +++ b/api/interfaces/ITableOptions.html @@ -1,4 +1,4 @@ -ITableOptions | docx

Interface ITableOptions

interface ITableOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    borders?: ITableBordersOptions;
    columnWidths?: readonly number[];
    float?: ITableFloatOptions;
    indent?: ITableWidthProperties;
    layout?: "fixed" | "autofit";
    margins?: ITableCellMarginOptions;
    rows: readonly TableRow[];
    style?: string;
    visuallyRightToLeft?: boolean;
    width?: ITableWidthProperties;
}

Properties

alignment? +ITableOptions | docx

Interface ITableOptions

interface ITableOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    borders?: ITableBordersOptions;
    columnWidths?: readonly number[];
    float?: ITableFloatOptions;
    indent?: ITableWidthProperties;
    layout?: "fixed" | "autofit";
    margins?: ITableCellMarginOptions;
    rows: readonly TableRow[];
    style?: string;
    visuallyRightToLeft?: boolean;
    width?: ITableWidthProperties;
}

Properties

alignment? borders? columnWidths? float? @@ -9,4 +9,4 @@ style? visuallyRightToLeft? width? -

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly borders

borders?: ITableBordersOptions

Optional Readonly columnWidths

columnWidths?: readonly number[]

Optional Readonly float

float?: ITableFloatOptions

Optional Readonly indent

indent?: ITableWidthProperties

Optional Readonly layout

layout?: "fixed" | "autofit"

Optional Readonly margins

margins?: ITableCellMarginOptions

Readonly rows

rows: readonly TableRow[]

Optional Readonly style

style?: string

Optional Readonly visuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonly width

width?: ITableWidthProperties

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly borders

borders?: ITableBordersOptions

Optional Readonly columnWidths

columnWidths?: readonly number[]

Optional Readonly float

float?: ITableFloatOptions

Optional Readonly indent

indent?: ITableWidthProperties

Optional Readonly layout

layout?: "fixed" | "autofit"

Optional Readonly margins

margins?: ITableCellMarginOptions

Readonly rows

rows: readonly TableRow[]

Optional Readonly style

style?: string

Optional Readonly visuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonly width

width?: ITableWidthProperties

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ITablePropertiesOptions.html b/api/interfaces/ITablePropertiesOptions.html index c337c70d1a..4b949414eb 100644 --- a/api/interfaces/ITablePropertiesOptions.html +++ b/api/interfaces/ITablePropertiesOptions.html @@ -1,4 +1,4 @@ -ITablePropertiesOptions | docx

Interface ITablePropertiesOptions

interface ITablePropertiesOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    borders?: ITableBordersOptions;
    cellMargin?: ITableCellMarginOptions;
    float?: ITableFloatOptions;
    indent?: ITableWidthProperties;
    layout?: "fixed" | "autofit";
    shading?: IShadingAttributesProperties;
    style?: string;
    visuallyRightToLeft?: boolean;
    width?: ITableWidthProperties;
}

Properties

alignment? +ITablePropertiesOptions | docx

Interface ITablePropertiesOptions

interface ITablePropertiesOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    borders?: ITableBordersOptions;
    cellMargin?: ITableCellMarginOptions;
    float?: ITableFloatOptions;
    indent?: ITableWidthProperties;
    layout?: "fixed" | "autofit";
    shading?: IShadingAttributesProperties;
    style?: string;
    visuallyRightToLeft?: boolean;
    width?: ITableWidthProperties;
}

Properties

alignment? borders? cellMargin? float? @@ -8,4 +8,4 @@ style? visuallyRightToLeft? width? -

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly borders

borders?: ITableBordersOptions

Optional Readonly cellMargin

cellMargin?: ITableCellMarginOptions

Optional Readonly float

float?: ITableFloatOptions

Optional Readonly indent

indent?: ITableWidthProperties

Optional Readonly layout

layout?: "fixed" | "autofit"

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly style

style?: string

Optional Readonly visuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonly width

width?: ITableWidthProperties

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly alignment

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Optional Readonly borders

borders?: ITableBordersOptions

Optional Readonly cellMargin

cellMargin?: ITableCellMarginOptions

Optional Readonly float

float?: ITableFloatOptions

Optional Readonly indent

indent?: ITableWidthProperties

Optional Readonly layout

layout?: "fixed" | "autofit"

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly style

style?: string

Optional Readonly visuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonly width

width?: ITableWidthProperties

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ITableRowOptions.html b/api/interfaces/ITableRowOptions.html index f0f251b937..5b324faa4b 100644 --- a/api/interfaces/ITableRowOptions.html +++ b/api/interfaces/ITableRowOptions.html @@ -1,5 +1,5 @@ -ITableRowOptions | docx

Interface ITableRowOptions

interface ITableRowOptions {
    cantSplit?: boolean;
    children: readonly TableCell[];
    height?: {
        rule: "auto" | "atLeast" | "exact";
        value: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    };
    tableHeader?: boolean;
}

Hierarchy

Properties

cantSplit? +ITableRowOptions | docx

Interface ITableRowOptions

interface ITableRowOptions {
    cantSplit?: boolean;
    children: readonly TableCell[];
    height?: {
        rule: "auto" | "atLeast" | "exact";
        value: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    };
    tableHeader?: boolean;
}

Hierarchy

Properties

cantSplit? children height? tableHeader? -

Properties

Optional Readonly cantSplit

cantSplit?: boolean

Readonly children

children: readonly TableCell[]

Optional Readonly height

height?: {
    rule: "auto" | "atLeast" | "exact";
    value: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
}

Type declaration

  • Readonly rule: "auto" | "atLeast" | "exact"
  • Readonly value: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly tableHeader

tableHeader?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly cantSplit

cantSplit?: boolean

Readonly children

children: readonly TableCell[]

Optional Readonly height

height?: {
    rule: "auto" | "atLeast" | "exact";
    value: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
}

Type declaration

  • Readonly rule: "auto" | "atLeast" | "exact"
  • Readonly value: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly tableHeader

tableHeader?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ITableRowPropertiesOptions.html b/api/interfaces/ITableRowPropertiesOptions.html index fbdf9b5b42..096462a4ea 100644 --- a/api/interfaces/ITableRowPropertiesOptions.html +++ b/api/interfaces/ITableRowPropertiesOptions.html @@ -1,4 +1,4 @@ -ITableRowPropertiesOptions | docx

Interface ITableRowPropertiesOptions

interface ITableRowPropertiesOptions {
    cantSplit?: boolean;
    height?: {
        rule: "auto" | "atLeast" | "exact";
        value: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    };
    tableHeader?: boolean;
}

Hierarchy

Properties

cantSplit? +ITableRowPropertiesOptions | docx

Interface ITableRowPropertiesOptions

interface ITableRowPropertiesOptions {
    cantSplit?: boolean;
    height?: {
        rule: "auto" | "atLeast" | "exact";
        value: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    };
    tableHeader?: boolean;
}

Hierarchy

Properties

cantSplit? height? tableHeader? -

Properties

Optional Readonly cantSplit

cantSplit?: boolean

Optional Readonly height

height?: {
    rule: "auto" | "atLeast" | "exact";
    value: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
}

Type declaration

  • Readonly rule: "auto" | "atLeast" | "exact"
  • Readonly value: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly tableHeader

tableHeader?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly cantSplit

cantSplit?: boolean

Optional Readonly height

height?: {
    rule: "auto" | "atLeast" | "exact";
    value: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
}

Type declaration

  • Readonly rule: "auto" | "atLeast" | "exact"
  • Readonly value: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly tableHeader

tableHeader?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/ITextWrapping.html b/api/interfaces/ITextWrapping.html index b34f85a8b0..1c169503b9 100644 --- a/api/interfaces/ITextWrapping.html +++ b/api/interfaces/ITextWrapping.html @@ -1,4 +1,4 @@ -ITextWrapping | docx

Interface ITextWrapping

interface ITextWrapping {
    margins?: IDistance;
    side?: "left" | "right" | "bothSides" | "largest";
    type: 0 | 2 | 1 | 3;
}

Properties

margins? +ITextWrapping | docx

Interface ITextWrapping

interface ITextWrapping {
    margins?: IDistance;
    side?: "left" | "right" | "bothSides" | "largest";
    type: 0 | 2 | 1 | 3;
}

Properties

margins? side? type -

Properties

Optional Readonly margins

margins?: IDistance

Optional Readonly side

side?: "left" | "right" | "bothSides" | "largest"

Readonly type

type: 0 | 2 | 1 | 3

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly margins

margins?: IDistance

Optional Readonly side

side?: "left" | "right" | "bothSides" | "largest"

Readonly type

type: 0 | 2 | 1 | 3

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IVerticalPositionOptions.html b/api/interfaces/IVerticalPositionOptions.html index b51844c6fd..f76d1bc4ed 100644 --- a/api/interfaces/IVerticalPositionOptions.html +++ b/api/interfaces/IVerticalPositionOptions.html @@ -1,4 +1,4 @@ -IVerticalPositionOptions | docx

Interface IVerticalPositionOptions

interface IVerticalPositionOptions {
    align?: "bottom" | "center" | "top" | "inside" | "outside";
    offset?: number;
    relative?: "margin" | "page" | "insideMargin" | "outsideMargin" | "bottomMargin" | "line" | "paragraph" | "topMargin";
}

Properties

align? +IVerticalPositionOptions | docx

Interface IVerticalPositionOptions

interface IVerticalPositionOptions {
    align?: "bottom" | "center" | "top" | "inside" | "outside";
    offset?: number;
    relative?: "margin" | "page" | "insideMargin" | "outsideMargin" | "bottomMargin" | "line" | "paragraph" | "topMargin";
}

Properties

align? offset? relative? -

Properties

Optional Readonly align

align?: "bottom" | "center" | "top" | "inside" | "outside"

Optional Readonly offset

offset?: number

Optional Readonly relative

relative?: "margin" | "page" | "insideMargin" | "outsideMargin" | "bottomMargin" | "line" | "paragraph" | "topMargin"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly align

align?: "bottom" | "center" | "top" | "inside" | "outside"

Optional Readonly offset

offset?: number

Optional Readonly relative

relative?: "margin" | "page" | "insideMargin" | "outsideMargin" | "bottomMargin" | "line" | "paragraph" | "topMargin"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IXYFrameOptions.html b/api/interfaces/IXYFrameOptions.html index aa89641ef5..51958daeed 100644 --- a/api/interfaces/IXYFrameOptions.html +++ b/api/interfaces/IXYFrameOptions.html @@ -1,4 +1,4 @@ -IXYFrameOptions | docx

Interface IXYFrameOptions

interface IXYFrameOptions {
    anchor: {
        horizontal: "text" | "margin" | "page";
        vertical: "text" | "margin" | "page";
    };
    anchorLock?: boolean;
    dropCap?: "none" | "margin" | "drop";
    height: number;
    lines?: number;
    position: {
        x: number;
        y: number;
    };
    rule?: "auto" | "atLeast" | "exact";
    space?: {
        horizontal: number;
        vertical: number;
    };
    width: number;
    wrap?: "auto" | "none" | "around" | "notBeside" | "through" | "tight";
}

Hierarchy

  • IBaseFrameOptions
    • IXYFrameOptions

Properties

anchor +IXYFrameOptions | docx

Interface IXYFrameOptions

interface IXYFrameOptions {
    anchor: {
        horizontal: "text" | "margin" | "page";
        vertical: "text" | "margin" | "page";
    };
    anchorLock?: boolean;
    dropCap?: "none" | "margin" | "drop";
    height: number;
    lines?: number;
    position: {
        x: number;
        y: number;
    };
    rule?: "auto" | "atLeast" | "exact";
    space?: {
        horizontal: number;
        vertical: number;
    };
    width: number;
    wrap?: "auto" | "none" | "around" | "notBeside" | "through" | "tight";
}

Hierarchy

  • IBaseFrameOptions
    • IXYFrameOptions

Properties

anchor anchorLock? dropCap? height @@ -8,4 +8,4 @@ space? width wrap? -

Properties

Readonly anchor

anchor: {
    horizontal: "text" | "margin" | "page";
    vertical: "text" | "margin" | "page";
}

Type declaration

  • Readonly horizontal: "text" | "margin" | "page"
  • Readonly vertical: "text" | "margin" | "page"

Optional Readonly anchorLock

anchorLock?: boolean

Optional Readonly dropCap

dropCap?: "none" | "margin" | "drop"

Readonly height

height: number

Optional Readonly lines

lines?: number

Readonly position

position: {
    x: number;
    y: number;
}

Type declaration

  • Readonly x: number
  • Readonly y: number

Optional Readonly rule

rule?: "auto" | "atLeast" | "exact"

Optional Readonly space

space?: {
    horizontal: number;
    vertical: number;
}

Type declaration

  • Readonly horizontal: number
  • Readonly vertical: number

Readonly width

width: number

Optional Readonly wrap

wrap?: "auto" | "none" | "around" | "notBeside" | "through" | "tight"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly anchor

anchor: {
    horizontal: "text" | "margin" | "page";
    vertical: "text" | "margin" | "page";
}

Type declaration

  • Readonly horizontal: "text" | "margin" | "page"
  • Readonly vertical: "text" | "margin" | "page"

Optional Readonly anchorLock

anchorLock?: boolean

Optional Readonly dropCap

dropCap?: "none" | "margin" | "drop"

Readonly height

height: number

Optional Readonly lines

lines?: number

Readonly position

position: {
    x: number;
    y: number;
}

Type declaration

  • Readonly x: number
  • Readonly y: number

Optional Readonly rule

rule?: "auto" | "atLeast" | "exact"

Optional Readonly space

space?: {
    horizontal: number;
    vertical: number;
}

Type declaration

  • Readonly horizontal: number
  • Readonly vertical: number

Readonly width

width: number

Optional Readonly wrap

wrap?: "auto" | "none" | "around" | "notBeside" | "through" | "tight"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IXmlAttribute.html b/api/interfaces/IXmlAttribute.html index 8498c6308e..cc6c926da0 100644 --- a/api/interfaces/IXmlAttribute.html +++ b/api/interfaces/IXmlAttribute.html @@ -1 +1 @@ -IXmlAttribute | docx

Interface IXmlAttribute

interface IXmlAttribute {
    [key: string]: string | number | boolean;
}

Indexable

[key: string]: string | number | boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +IXmlAttribute | docx

Interface IXmlAttribute

interface IXmlAttribute {
    [key: string]: string | number | boolean;
}

Indexable

[key: string]: string | number | boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/IXmlableObject.html b/api/interfaces/IXmlableObject.html index acb8e83fa7..cfd3807096 100644 --- a/api/interfaces/IXmlableObject.html +++ b/api/interfaces/IXmlableObject.html @@ -1 +1 @@ -IXmlableObject | docx

Interface IXmlableObject

interface IXmlableObject {
    [key: string]: any;
}

Hierarchy

  • Record<string, unknown>
    • IXmlableObject

Indexable

[key: string]: any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +IXmlableObject | docx

Interface IXmlableObject

interface IXmlableObject {
    [key: string]: any;
}

Hierarchy

  • Record<string, unknown>
    • IXmlableObject

Indexable

[key: string]: any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/PatchDocumentOptions.html b/api/interfaces/PatchDocumentOptions.html index a3a98376cd..c6a77e4b97 100644 --- a/api/interfaces/PatchDocumentOptions.html +++ b/api/interfaces/PatchDocumentOptions.html @@ -1,3 +1,3 @@ -PatchDocumentOptions | docx

Interface PatchDocumentOptions

interface PatchDocumentOptions {
    keepOriginalStyles?: boolean;
    patches: {
        [key: string]: IPatch;
    };
}

Properties

keepOriginalStyles? +PatchDocumentOptions | docx

Interface PatchDocumentOptions

interface PatchDocumentOptions {
    keepOriginalStyles?: boolean;
    patches: {
        [key: string]: IPatch;
    };
}

Properties

keepOriginalStyles? patches -

Properties

Optional Readonly keepOriginalStyles

keepOriginalStyles?: boolean

Readonly patches

patches: {
    [key: string]: IPatch;
}

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly keepOriginalStyles

keepOriginalStyles?: boolean

Readonly patches

patches: {
    [key: string]: IPatch;
}

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/PositionalTabOptions.html b/api/interfaces/PositionalTabOptions.html index 7c9898d1ba..f5676ddfc6 100644 --- a/api/interfaces/PositionalTabOptions.html +++ b/api/interfaces/PositionalTabOptions.html @@ -1,4 +1,4 @@ -PositionalTabOptions | docx

Interface PositionalTabOptions

interface PositionalTabOptions {
    alignment: "center" | "left" | "right";
    leader: "none" | "dot" | "hyphen" | "underscore" | "middleDot";
    relativeTo: "indent" | "margin";
}

Properties

alignment +PositionalTabOptions | docx

Interface PositionalTabOptions

interface PositionalTabOptions {
    alignment: "center" | "left" | "right";
    leader: "none" | "dot" | "hyphen" | "underscore" | "middleDot";
    relativeTo: "indent" | "margin";
}

Properties

alignment leader relativeTo -

Properties

Readonly alignment

alignment: "center" | "left" | "right"

Readonly leader

leader: "none" | "dot" | "hyphen" | "underscore" | "middleDot"

Readonly relativeTo

relativeTo: "indent" | "margin"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly alignment

alignment: "center" | "left" | "right"

Readonly leader

leader: "none" | "dot" | "hyphen" | "underscore" | "middleDot"

Readonly relativeTo

relativeTo: "indent" | "margin"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/interfaces/TabStopDefinition.html b/api/interfaces/TabStopDefinition.html index b4f8661695..20f4f53dd4 100644 --- a/api/interfaces/TabStopDefinition.html +++ b/api/interfaces/TabStopDefinition.html @@ -1,4 +1,4 @@ -TabStopDefinition | docx

Interface TabStopDefinition

interface TabStopDefinition {
    leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot";
    position: number;
    type: "center" | "clear" | "left" | "right" | "start" | "end" | "decimal" | "bar" | "num";
}

Properties

leader? +TabStopDefinition | docx

Interface TabStopDefinition

interface TabStopDefinition {
    leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot";
    position: number;
    type: "center" | "clear" | "left" | "right" | "start" | "end" | "decimal" | "bar" | "num";
}

Properties

leader? position type -

Properties

Optional Readonly leader

leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot"

Readonly position

position: number

Readonly type

type: "center" | "clear" | "left" | "right" | "start" | "end" | "decimal" | "bar" | "num"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly leader

leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot"

Readonly position

position: number

Readonly type

type: "center" | "clear" | "left" | "right" | "start" | "end" | "decimal" | "bar" | "num"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/AttributeData.html b/api/types/AttributeData.html index b0ae8559ea..53278b5c41 100644 --- a/api/types/AttributeData.html +++ b/api/types/AttributeData.html @@ -1 +1 @@ -AttributeData | docx

Type alias AttributeData

AttributeData: {
    [key: string]: boolean | number | string;
}

Type declaration

  • [key: string]: boolean | number | string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +AttributeData | docx

Type alias AttributeData

AttributeData: {
    [key: string]: boolean | number | string;
}

Type declaration

  • [key: string]: boolean | number | string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/AttributeMap.html b/api/types/AttributeMap.html index 85559f9ba7..1b4c1b395a 100644 --- a/api/types/AttributeMap.html +++ b/api/types/AttributeMap.html @@ -1 +1 @@ -AttributeMap | docx

Type alias AttributeMap<T>

AttributeMap<T>: {
    readonly [P in keyof T]: string
}

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +AttributeMap | docx

Type alias AttributeMap<T>

AttributeMap<T>: {
    readonly [P in keyof T]: string
}

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/AttributePayload.html b/api/types/AttributePayload.html index 448883eb21..ff5718e479 100644 --- a/api/types/AttributePayload.html +++ b/api/types/AttributePayload.html @@ -1 +1 @@ -AttributePayload | docx

Type alias AttributePayload<T>

AttributePayload<T>: {
    readonly [P in keyof T]: {
        key: string;
        value: T[P];
    }
}

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +AttributePayload | docx

Type alias AttributePayload<T>

AttributePayload<T>: {
    readonly [P in keyof T]: {
        key: string;
        value: T[P];
    }
}

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/IColumnsAttributes.html b/api/types/IColumnsAttributes.html index 2dc1e5625d..f633ca4a8f 100644 --- a/api/types/IColumnsAttributes.html +++ b/api/types/IColumnsAttributes.html @@ -1 +1 @@ -IColumnsAttributes | docx

Type alias IColumnsAttributes

IColumnsAttributes: {
    children?: readonly Column[];
    count?: number;
    equalWidth?: boolean;
    separate?: boolean;
    space?: number | PositiveUniversalMeasure;
}

Type declaration

  • Optional Readonly children?: readonly Column[]
  • Optional Readonly count?: number
  • Optional Readonly equalWidth?: boolean
  • Optional Readonly separate?: boolean
  • Optional Readonly space?: number | PositiveUniversalMeasure

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +IColumnsAttributes | docx

Type alias IColumnsAttributes

IColumnsAttributes: {
    children?: readonly Column[];
    count?: number;
    equalWidth?: boolean;
    separate?: boolean;
    space?: number | PositiveUniversalMeasure;
}

Type declaration

  • Optional Readonly children?: readonly Column[]
  • Optional Readonly count?: number
  • Optional Readonly equalWidth?: boolean
  • Optional Readonly separate?: boolean
  • Optional Readonly space?: number | PositiveUniversalMeasure

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/IFrameOptions.html b/api/types/IFrameOptions.html index 13093c51c2..054caa7a28 100644 --- a/api/types/IFrameOptions.html +++ b/api/types/IFrameOptions.html @@ -1 +1 @@ -IFrameOptions | docx

Type alias IFrameOptions

IFrameOptions: IXYFrameOptions | IAlignmentFrameOptions

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +IFrameOptions | docx

Type alias IFrameOptions

IFrameOptions: IXYFrameOptions | IAlignmentFrameOptions

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/ILineNumberAttributes.html b/api/types/ILineNumberAttributes.html index 4a84a35356..e646ed20e5 100644 --- a/api/types/ILineNumberAttributes.html +++ b/api/types/ILineNumberAttributes.html @@ -1 +1 @@ -ILineNumberAttributes | docx

Type alias ILineNumberAttributes

ILineNumberAttributes: {
    countBy?: number;
    distance?: number | PositiveUniversalMeasure;
    restart?: typeof LineNumberRestartFormat[keyof typeof LineNumberRestartFormat];
    start?: number;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ILineNumberAttributes | docx

Type alias ILineNumberAttributes

ILineNumberAttributes: {
    countBy?: number;
    distance?: number | PositiveUniversalMeasure;
    restart?: typeof LineNumberRestartFormat[keyof typeof LineNumberRestartFormat];
    start?: number;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/IPageMarginAttributes.html b/api/types/IPageMarginAttributes.html index 32f8232764..5818cdde99 100644 --- a/api/types/IPageMarginAttributes.html +++ b/api/types/IPageMarginAttributes.html @@ -1 +1 @@ -IPageMarginAttributes | docx

Type alias IPageMarginAttributes

IPageMarginAttributes: {
    bottom?: number | UniversalMeasure;
    footer?: number | PositiveUniversalMeasure;
    gutter?: number | PositiveUniversalMeasure;
    header?: number | PositiveUniversalMeasure;
    left?: number | PositiveUniversalMeasure;
    right?: number | PositiveUniversalMeasure;
    top?: number | UniversalMeasure;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +IPageMarginAttributes | docx

Type alias IPageMarginAttributes

IPageMarginAttributes: {
    bottom?: number | UniversalMeasure;
    footer?: number | PositiveUniversalMeasure;
    gutter?: number | PositiveUniversalMeasure;
    header?: number | PositiveUniversalMeasure;
    left?: number | PositiveUniversalMeasure;
    right?: number | PositiveUniversalMeasure;
    top?: number | UniversalMeasure;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/IPageReferenceOptions.html b/api/types/IPageReferenceOptions.html index d90674ce95..1788056bc7 100644 --- a/api/types/IPageReferenceOptions.html +++ b/api/types/IPageReferenceOptions.html @@ -4,4 +4,4 @@ bookmark, it omits "on page #" and returns "above" or "below" only. If the PAGEREF field is not on the same page as the bookmark, the string "on page #" is used.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/IPageSizeAttributes.html b/api/types/IPageSizeAttributes.html index f1b2703d4c..5738ad9565 100644 --- a/api/types/IPageSizeAttributes.html +++ b/api/types/IPageSizeAttributes.html @@ -1 +1 @@ -IPageSizeAttributes | docx

Type alias IPageSizeAttributes

IPageSizeAttributes: {
    height?: number | PositiveUniversalMeasure;
    orientation?: typeof PageOrientation[keyof typeof PageOrientation];
    width?: number | PositiveUniversalMeasure;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +IPageSizeAttributes | docx

Type alias IPageSizeAttributes

IPageSizeAttributes: {
    height?: number | PositiveUniversalMeasure;
    orientation?: typeof PageOrientation[keyof typeof PageOrientation];
    width?: number | PositiveUniversalMeasure;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/IPatch.html b/api/types/IPatch.html index 91750fe69d..5a43aed15a 100644 --- a/api/types/IPatch.html +++ b/api/types/IPatch.html @@ -1 +1 @@ -IPatch | docx

Type alias IPatch

IPatch: ParagraphPatch | FilePatch

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +IPatch | docx

Type alias IPatch

IPatch: ParagraphPatch | FilePatch

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/ITableFloatOptions.html b/api/types/ITableFloatOptions.html index 55f551eacb..358f9942bc 100644 --- a/api/types/ITableFloatOptions.html +++ b/api/types/ITableFloatOptions.html @@ -44,4 +44,4 @@ margin - relative to the horizontal edge of the text margin before any text runs page - relative to the horizontal edge of the page before any text runs (top edge for top-to-bottom paragraphs) text - relative to the horizontal edge of the text margin for the column in which the anchor paragraph is located If omitted, the value is assumed to be page.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/ITableWidthProperties.html b/api/types/ITableWidthProperties.html index 5f7d223be4..842ed7648f 100644 --- a/api/types/ITableWidthProperties.html +++ b/api/types/ITableWidthProperties.html @@ -1 +1 @@ -ITableWidthProperties | docx

Type alias ITableWidthProperties

ITableWidthProperties: {
    size: number | Percentage | UniversalMeasure;
    type?: typeof WidthType[keyof typeof WidthType];
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ITableWidthProperties | docx

Type alias ITableWidthProperties

ITableWidthProperties: {
    size: number | Percentage | UniversalMeasure;
    type?: typeof WidthType[keyof typeof WidthType];
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/MathComponent.html b/api/types/MathComponent.html index 75df3a98ab..354ceec6e4 100644 --- a/api/types/MathComponent.html +++ b/api/types/MathComponent.html @@ -1 +1 @@ -MathComponent | docx

Type alias MathComponent

MathComponent: MathRun | MathFraction | MathSum | MathIntegral | MathSuperScript | MathSubScript | MathSubSuperScript | MathRadical | MathFunction | MathRoundBrackets | MathCurlyBrackets | MathAngledBrackets | MathSquareBrackets

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +MathComponent | docx

Type alias MathComponent

MathComponent: MathRun | MathFraction | MathSum | MathIntegral | MathSuperScript | MathSubScript | MathSubSuperScript | MathRadical | MathFunction | MathRoundBrackets | MathCurlyBrackets | MathAngledBrackets | MathSquareBrackets

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/ParagraphChild.html b/api/types/ParagraphChild.html index e30d24dbd8..3e08f64547 100644 --- a/api/types/ParagraphChild.html +++ b/api/types/ParagraphChild.html @@ -1 +1 @@ -ParagraphChild | docx

Type alias ParagraphChild

ParagraphChild: TextRun | ImageRun | SymbolRun | Bookmark | PageBreak | ColumnBreak | SequentialIdentifier | FootnoteReferenceRun | InternalHyperlink | ExternalHyperlink | InsertedTextRun | DeletedTextRun | Math | SimpleField | SimpleMailMergeField | Comments | Comment | CommentRangeStart | CommentRangeEnd | CommentReference | CheckBox

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ParagraphChild | docx

Type alias ParagraphChild

ParagraphChild: TextRun | ImageRun | SymbolRun | Bookmark | PageBreak | ColumnBreak | SequentialIdentifier | FootnoteReferenceRun | InternalHyperlink | ExternalHyperlink | InsertedTextRun | DeletedTextRun | Math | SimpleField | SimpleMailMergeField | Comments | Comment | CommentRangeStart | CommentRangeEnd | CommentReference | CheckBox

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/Percentage.html b/api/types/Percentage.html index a626e70d0e..0b2d787fca 100644 --- a/api/types/Percentage.html +++ b/api/types/Percentage.html @@ -1 +1 @@ -Percentage | docx

Type alias Percentage

Percentage: `${"-" | ""}${number}%`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Percentage | docx

Type alias Percentage

Percentage: `${"-" | ""}${number}%`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/PositiveUniversalMeasure.html b/api/types/PositiveUniversalMeasure.html index 632da4efe2..a933d4ddb1 100644 --- a/api/types/PositiveUniversalMeasure.html +++ b/api/types/PositiveUniversalMeasure.html @@ -1 +1 @@ -PositiveUniversalMeasure | docx

Type alias PositiveUniversalMeasure

PositiveUniversalMeasure: `${number}${"mm" | "cm" | "in" | "pt" | "pc" | "pi"}`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +PositiveUniversalMeasure | docx

Type alias PositiveUniversalMeasure

PositiveUniversalMeasure: `${number}${"mm" | "cm" | "in" | "pt" | "pc" | "pi"}`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/UniqueNumericIdCreator.html b/api/types/UniqueNumericIdCreator.html index 40a4db4737..6b4cb7d36f 100644 --- a/api/types/UniqueNumericIdCreator.html +++ b/api/types/UniqueNumericIdCreator.html @@ -1 +1 @@ -UniqueNumericIdCreator | docx

Type alias UniqueNumericIdCreator

UniqueNumericIdCreator: (() => number)

Type declaration

    • (): number

    • Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +UniqueNumericIdCreator | docx

Type alias UniqueNumericIdCreator

UniqueNumericIdCreator: (() => number)

Type declaration

    • (): number

    • Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/types/UniversalMeasure.html b/api/types/UniversalMeasure.html index 4d0103c2d5..fd3ad88f80 100644 --- a/api/types/UniversalMeasure.html +++ b/api/types/UniversalMeasure.html @@ -1 +1 @@ -UniversalMeasure | docx

Type alias UniversalMeasure

UniversalMeasure: `${"-" | ""}${number}${"mm" | "cm" | "in" | "pt" | "pc" | "pi"}`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +UniversalMeasure | docx

Type alias UniversalMeasure

UniversalMeasure: `${"-" | ""}${number}${"mm" | "cm" | "in" | "pt" | "pc" | "pi"}`

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/api/variables/AlignmentType.html b/api/variables/AlignmentType.html index 66c0f9de1f..e839b06e85 100644 --- a/api/variables/AlignmentType.html +++ b/api/variables/AlignmentType.html @@ -11,4 +11,4 @@
  • Readonly RIGHT: "right"

    Align Right

  • Readonly START: "start"

    Align Start

  • Readonly THAI_DISTRIBUTE: "thaiDistribute"

    Thai Language Justification

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/variables/BorderStyle.html b/api/variables/BorderStyle.html index 3cbd921677..6f9c1a4763 100644 --- a/api/variables/BorderStyle.html +++ b/api/variables/BorderStyle.html @@ -1 +1 @@ -BorderStyle | docx

    Variable BorderStyleConst

    BorderStyle: {
        DASHED: "dashed";
        DASH_DOT_STROKED: "dashDotStroked";
        DASH_SMALL_GAP: "dashSmallGap";
        DOTTED: "dotted";
        DOT_DASH: "dotDash";
        DOT_DOT_DASH: "dotDotDash";
        DOUBLE: "double";
        DOUBLE_WAVE: "doubleWave";
        INSET: "inset";
        NIL: "nil";
        NONE: "none";
        OUTSET: "outset";
        SINGLE: "single";
        THICK: "thick";
        THICK_THIN_LARGE_GAP: "thickThinLargeGap";
        THICK_THIN_MEDIUM_GAP: "thickThinMediumGap";
        THICK_THIN_SMALL_GAP: "thickThinSmallGap";
        THIN_THICK_LARGE_GAP: "thinThickLargeGap";
        THIN_THICK_MEDIUM_GAP: "thinThickMediumGap";
        THIN_THICK_SMALL_GAP: "thinThickSmallGap";
        THIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap";
        THIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap";
        THIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap";
        THREE_D_EMBOSS: "threeDEmboss";
        THREE_D_ENGRAVE: "threeDEngrave";
        TRIPLE: "triple";
        WAVE: "wave";
    } = ...

    Type declaration

    • Readonly DASHED: "dashed"
    • Readonly DASH_DOT_STROKED: "dashDotStroked"
    • Readonly DASH_SMALL_GAP: "dashSmallGap"
    • Readonly DOTTED: "dotted"
    • Readonly DOT_DASH: "dotDash"
    • Readonly DOT_DOT_DASH: "dotDotDash"
    • Readonly DOUBLE: "double"
    • Readonly DOUBLE_WAVE: "doubleWave"
    • Readonly INSET: "inset"
    • Readonly NIL: "nil"
    • Readonly NONE: "none"
    • Readonly OUTSET: "outset"
    • Readonly SINGLE: "single"
    • Readonly THICK: "thick"
    • Readonly THICK_THIN_LARGE_GAP: "thickThinLargeGap"
    • Readonly THICK_THIN_MEDIUM_GAP: "thickThinMediumGap"
    • Readonly THICK_THIN_SMALL_GAP: "thickThinSmallGap"
    • Readonly THIN_THICK_LARGE_GAP: "thinThickLargeGap"
    • Readonly THIN_THICK_MEDIUM_GAP: "thinThickMediumGap"
    • Readonly THIN_THICK_SMALL_GAP: "thinThickSmallGap"
    • Readonly THIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap"
    • Readonly THIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap"
    • Readonly THIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap"
    • Readonly THREE_D_EMBOSS: "threeDEmboss"
    • Readonly THREE_D_ENGRAVE: "threeDEngrave"
    • Readonly TRIPLE: "triple"
    • Readonly WAVE: "wave"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +BorderStyle | docx

    Variable BorderStyleConst

    BorderStyle: {
        DASHED: "dashed";
        DASH_DOT_STROKED: "dashDotStroked";
        DASH_SMALL_GAP: "dashSmallGap";
        DOTTED: "dotted";
        DOT_DASH: "dotDash";
        DOT_DOT_DASH: "dotDotDash";
        DOUBLE: "double";
        DOUBLE_WAVE: "doubleWave";
        INSET: "inset";
        NIL: "nil";
        NONE: "none";
        OUTSET: "outset";
        SINGLE: "single";
        THICK: "thick";
        THICK_THIN_LARGE_GAP: "thickThinLargeGap";
        THICK_THIN_MEDIUM_GAP: "thickThinMediumGap";
        THICK_THIN_SMALL_GAP: "thickThinSmallGap";
        THIN_THICK_LARGE_GAP: "thinThickLargeGap";
        THIN_THICK_MEDIUM_GAP: "thinThickMediumGap";
        THIN_THICK_SMALL_GAP: "thinThickSmallGap";
        THIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap";
        THIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap";
        THIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap";
        THREE_D_EMBOSS: "threeDEmboss";
        THREE_D_ENGRAVE: "threeDEngrave";
        TRIPLE: "triple";
        WAVE: "wave";
    } = ...

    Type declaration

    • Readonly DASHED: "dashed"
    • Readonly DASH_DOT_STROKED: "dashDotStroked"
    • Readonly DASH_SMALL_GAP: "dashSmallGap"
    • Readonly DOTTED: "dotted"
    • Readonly DOT_DASH: "dotDash"
    • Readonly DOT_DOT_DASH: "dotDotDash"
    • Readonly DOUBLE: "double"
    • Readonly DOUBLE_WAVE: "doubleWave"
    • Readonly INSET: "inset"
    • Readonly NIL: "nil"
    • Readonly NONE: "none"
    • Readonly OUTSET: "outset"
    • Readonly SINGLE: "single"
    • Readonly THICK: "thick"
    • Readonly THICK_THIN_LARGE_GAP: "thickThinLargeGap"
    • Readonly THICK_THIN_MEDIUM_GAP: "thickThinMediumGap"
    • Readonly THICK_THIN_SMALL_GAP: "thickThinSmallGap"
    • Readonly THIN_THICK_LARGE_GAP: "thinThickLargeGap"
    • Readonly THIN_THICK_MEDIUM_GAP: "thinThickMediumGap"
    • Readonly THIN_THICK_SMALL_GAP: "thinThickSmallGap"
    • Readonly THIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap"
    • Readonly THIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap"
    • Readonly THIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap"
    • Readonly THREE_D_EMBOSS: "threeDEmboss"
    • Readonly THREE_D_ENGRAVE: "threeDEngrave"
    • Readonly TRIPLE: "triple"
    • Readonly WAVE: "wave"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/variables/DocumentGridType.html b/api/variables/DocumentGridType.html index 5d3a328117..7e98836fb5 100644 --- a/api/variables/DocumentGridType.html +++ b/api/variables/DocumentGridType.html @@ -1 +1 @@ -DocumentGridType | docx

    Variable DocumentGridTypeConst

    DocumentGridType: {
        DEFAULT: "default";
        LINES: "lines";
        LINES_AND_CHARS: "linesAndChars";
        SNAP_TO_CHARS: "snapToChars";
    } = ...

    Type declaration

    • Readonly DEFAULT: "default"
    • Readonly LINES: "lines"
    • Readonly LINES_AND_CHARS: "linesAndChars"
    • Readonly SNAP_TO_CHARS: "snapToChars"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DocumentGridType | docx

    Variable DocumentGridTypeConst

    DocumentGridType: {
        DEFAULT: "default";
        LINES: "lines";
        LINES_AND_CHARS: "linesAndChars";
        SNAP_TO_CHARS: "snapToChars";
    } = ...

    Type declaration

    • Readonly DEFAULT: "default"
    • Readonly LINES: "lines"
    • Readonly LINES_AND_CHARS: "linesAndChars"
    • Readonly SNAP_TO_CHARS: "snapToChars"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/variables/DropCapType.html b/api/variables/DropCapType.html index 370abc59e8..95433a05bf 100644 --- a/api/variables/DropCapType.html +++ b/api/variables/DropCapType.html @@ -1 +1 @@ -DropCapType | docx

    Variable DropCapTypeConst

    DropCapType: {
        DROP: "drop";
        MARGIN: "margin";
        NONE: "none";
    } = ...

    Type declaration

    • Readonly DROP: "drop"
    • Readonly MARGIN: "margin"
    • Readonly NONE: "none"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DropCapType | docx

    Variable DropCapTypeConst

    DropCapType: {
        DROP: "drop";
        MARGIN: "margin";
        NONE: "none";
    } = ...

    Type declaration

    • Readonly DROP: "drop"
    • Readonly MARGIN: "margin"
    • Readonly NONE: "none"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/api/variables/EMPTY_OBJECT.html b/api/variables/EMPTY_OBJECT.html index 287dc2ba75..c34719ee90 100644 --- a/api/variables/EMPTY_OBJECT.html +++ b/api/variables/EMPTY_OBJECT.html @@ -1 +1 @@ -EMPTY_OBJECT | docx

    Variable EMPTY_OBJECTConst

    EMPTY_OBJECT: {} = ...

    Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +EMPTY_OBJECT | docx

      Variable EMPTY_OBJECTConst

      EMPTY_OBJECT: {} = ...

      Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/EmphasisMarkType.html b/api/variables/EmphasisMarkType.html index 2223bf69c0..62b03233ed 100644 --- a/api/variables/EmphasisMarkType.html +++ b/api/variables/EmphasisMarkType.html @@ -1 +1 @@ -EmphasisMarkType | docx

        Variable EmphasisMarkTypeConst

        EmphasisMarkType: {
            DOT: "dot";
        } = ...

        Type declaration

        • Readonly DOT: "dot"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +EmphasisMarkType | docx

        Variable EmphasisMarkTypeConst

        EmphasisMarkType: {
            DOT: "dot";
        } = ...

        Type declaration

        • Readonly DOT: "dot"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/FrameAnchorType.html b/api/variables/FrameAnchorType.html index e4fce85374..9b9b1e1848 100644 --- a/api/variables/FrameAnchorType.html +++ b/api/variables/FrameAnchorType.html @@ -1 +1 @@ -FrameAnchorType | docx

        Variable FrameAnchorTypeConst

        FrameAnchorType: {
            MARGIN: "margin";
            PAGE: "page";
            TEXT: "text";
        } = ...

        Type declaration

        • Readonly MARGIN: "margin"
        • Readonly PAGE: "page"
        • Readonly TEXT: "text"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +FrameAnchorType | docx

        Variable FrameAnchorTypeConst

        FrameAnchorType: {
            MARGIN: "margin";
            PAGE: "page";
            TEXT: "text";
        } = ...

        Type declaration

        • Readonly MARGIN: "margin"
        • Readonly PAGE: "page"
        • Readonly TEXT: "text"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/FrameWrap.html b/api/variables/FrameWrap.html index 6c4fb42420..45e50e27e9 100644 --- a/api/variables/FrameWrap.html +++ b/api/variables/FrameWrap.html @@ -1 +1 @@ -FrameWrap | docx

        Variable FrameWrapConst

        FrameWrap: {
            AROUND: "around";
            AUTO: "auto";
            NONE: "none";
            NOT_BESIDE: "notBeside";
            THROUGH: "through";
            TIGHT: "tight";
        } = ...

        Type declaration

        • Readonly AROUND: "around"
        • Readonly AUTO: "auto"
        • Readonly NONE: "none"
        • Readonly NOT_BESIDE: "notBeside"
        • Readonly THROUGH: "through"
        • Readonly TIGHT: "tight"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +FrameWrap | docx

        Variable FrameWrapConst

        FrameWrap: {
            AROUND: "around";
            AUTO: "auto";
            NONE: "none";
            NOT_BESIDE: "notBeside";
            THROUGH: "through";
            TIGHT: "tight";
        } = ...

        Type declaration

        • Readonly AROUND: "around"
        • Readonly AUTO: "auto"
        • Readonly NONE: "none"
        • Readonly NOT_BESIDE: "notBeside"
        • Readonly THROUGH: "through"
        • Readonly TIGHT: "tight"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/HeaderFooterReferenceType.html b/api/variables/HeaderFooterReferenceType.html index 1079144e89..f6b211eb57 100644 --- a/api/variables/HeaderFooterReferenceType.html +++ b/api/variables/HeaderFooterReferenceType.html @@ -1 +1 @@ -HeaderFooterReferenceType | docx

        Variable HeaderFooterReferenceTypeConst

        HeaderFooterReferenceType: {
            DEFAULT: "default";
            EVEN: "even";
            FIRST: "first";
        } = ...

        Type declaration

        • Readonly DEFAULT: "default"
        • Readonly EVEN: "even"
        • Readonly FIRST: "first"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +HeaderFooterReferenceType | docx

        Variable HeaderFooterReferenceTypeConst

        HeaderFooterReferenceType: {
            DEFAULT: "default";
            EVEN: "even";
            FIRST: "first";
        } = ...

        Type declaration

        • Readonly DEFAULT: "default"
        • Readonly EVEN: "even"
        • Readonly FIRST: "first"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/HeaderFooterType.html b/api/variables/HeaderFooterType.html index 3141718587..a7a16c5d31 100644 --- a/api/variables/HeaderFooterType.html +++ b/api/variables/HeaderFooterType.html @@ -1 +1 @@ -HeaderFooterType | docx

        Variable HeaderFooterTypeConst

        HeaderFooterType: {
            FOOTER: "w:footerReference";
            HEADER: "w:headerReference";
        } = ...

        Type declaration

        • Readonly FOOTER: "w:footerReference"
        • Readonly HEADER: "w:headerReference"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +HeaderFooterType | docx

        Variable HeaderFooterTypeConst

        HeaderFooterType: {
            FOOTER: "w:footerReference";
            HEADER: "w:headerReference";
        } = ...

        Type declaration

        • Readonly FOOTER: "w:footerReference"
        • Readonly HEADER: "w:headerReference"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/HeadingLevel.html b/api/variables/HeadingLevel.html index deee2d9108..897cd7a416 100644 --- a/api/variables/HeadingLevel.html +++ b/api/variables/HeadingLevel.html @@ -1 +1 @@ -HeadingLevel | docx

        Variable HeadingLevelConst

        HeadingLevel: {
            HEADING_1: "Heading1";
            HEADING_2: "Heading2";
            HEADING_3: "Heading3";
            HEADING_4: "Heading4";
            HEADING_5: "Heading5";
            HEADING_6: "Heading6";
            TITLE: "Title";
        } = ...

        Type declaration

        • Readonly HEADING_1: "Heading1"
        • Readonly HEADING_2: "Heading2"
        • Readonly HEADING_3: "Heading3"
        • Readonly HEADING_4: "Heading4"
        • Readonly HEADING_5: "Heading5"
        • Readonly HEADING_6: "Heading6"
        • Readonly TITLE: "Title"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +HeadingLevel | docx

        Variable HeadingLevelConst

        HeadingLevel: {
            HEADING_1: "Heading1";
            HEADING_2: "Heading2";
            HEADING_3: "Heading3";
            HEADING_4: "Heading4";
            HEADING_5: "Heading5";
            HEADING_6: "Heading6";
            TITLE: "Title";
        } = ...

        Type declaration

        • Readonly HEADING_1: "Heading1"
        • Readonly HEADING_2: "Heading2"
        • Readonly HEADING_3: "Heading3"
        • Readonly HEADING_4: "Heading4"
        • Readonly HEADING_5: "Heading5"
        • Readonly HEADING_6: "Heading6"
        • Readonly TITLE: "Title"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/HeightRule.html b/api/variables/HeightRule.html index 20f4df74f2..48894dcd70 100644 --- a/api/variables/HeightRule.html +++ b/api/variables/HeightRule.html @@ -1,4 +1,4 @@ HeightRule | docx

        Variable HeightRuleConst

        HeightRule: {
            ATLEAST: "atLeast";
            AUTO: "auto";
            EXACT: "exact";
        } = ...

        Type declaration

        • Readonly ATLEAST: "atLeast"

          At least the value specified

        • Readonly AUTO: "auto"

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

        • Readonly EXACT: "exact"

          Exactly the value specified

          -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/HorizontalPositionAlign.html b/api/variables/HorizontalPositionAlign.html index 65b7a1f651..9614980dca 100644 --- a/api/variables/HorizontalPositionAlign.html +++ b/api/variables/HorizontalPositionAlign.html @@ -1 +1 @@ -HorizontalPositionAlign | docx

        Variable HorizontalPositionAlignConst

        HorizontalPositionAlign: {
            CENTER: "center";
            INSIDE: "inside";
            LEFT: "left";
            OUTSIDE: "outside";
            RIGHT: "right";
        } = ...

        Type declaration

        • Readonly CENTER: "center"
        • Readonly INSIDE: "inside"
        • Readonly LEFT: "left"
        • Readonly OUTSIDE: "outside"
        • Readonly RIGHT: "right"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +HorizontalPositionAlign | docx

        Variable HorizontalPositionAlignConst

        HorizontalPositionAlign: {
            CENTER: "center";
            INSIDE: "inside";
            LEFT: "left";
            OUTSIDE: "outside";
            RIGHT: "right";
        } = ...

        Type declaration

        • Readonly CENTER: "center"
        • Readonly INSIDE: "inside"
        • Readonly LEFT: "left"
        • Readonly OUTSIDE: "outside"
        • Readonly RIGHT: "right"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/HorizontalPositionRelativeFrom.html b/api/variables/HorizontalPositionRelativeFrom.html index 49dbf3f1c9..b17a38b66c 100644 --- a/api/variables/HorizontalPositionRelativeFrom.html +++ b/api/variables/HorizontalPositionRelativeFrom.html @@ -1 +1 @@ -HorizontalPositionRelativeFrom | docx

        Variable HorizontalPositionRelativeFromConst

        HorizontalPositionRelativeFrom: {
            CHARACTER: "character";
            COLUMN: "column";
            INSIDE_MARGIN: "insideMargin";
            LEFT_MARGIN: "leftMargin";
            MARGIN: "margin";
            OUTSIDE_MARGIN: "outsideMargin";
            PAGE: "page";
            RIGHT_MARGIN: "rightMargin";
        } = ...

        Type declaration

        • Readonly CHARACTER: "character"
        • Readonly COLUMN: "column"
        • Readonly INSIDE_MARGIN: "insideMargin"
        • Readonly LEFT_MARGIN: "leftMargin"
        • Readonly MARGIN: "margin"
        • Readonly OUTSIDE_MARGIN: "outsideMargin"
        • Readonly PAGE: "page"
        • Readonly RIGHT_MARGIN: "rightMargin"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +HorizontalPositionRelativeFrom | docx

        Variable HorizontalPositionRelativeFromConst

        HorizontalPositionRelativeFrom: {
            CHARACTER: "character";
            COLUMN: "column";
            INSIDE_MARGIN: "insideMargin";
            LEFT_MARGIN: "leftMargin";
            MARGIN: "margin";
            OUTSIDE_MARGIN: "outsideMargin";
            PAGE: "page";
            RIGHT_MARGIN: "rightMargin";
        } = ...

        Type declaration

        • Readonly CHARACTER: "character"
        • Readonly COLUMN: "column"
        • Readonly INSIDE_MARGIN: "insideMargin"
        • Readonly LEFT_MARGIN: "leftMargin"
        • Readonly MARGIN: "margin"
        • Readonly OUTSIDE_MARGIN: "outsideMargin"
        • Readonly PAGE: "page"
        • Readonly RIGHT_MARGIN: "rightMargin"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/HyperlinkType.html b/api/variables/HyperlinkType.html index a7a3c40acc..b73cc8f28b 100644 --- a/api/variables/HyperlinkType.html +++ b/api/variables/HyperlinkType.html @@ -1 +1 @@ -HyperlinkType | docx

        Variable HyperlinkTypeConst

        HyperlinkType: {
            EXTERNAL: "EXTERNAL";
            INTERNAL: "INTERNAL";
        } = ...

        Type declaration

        • Readonly EXTERNAL: "EXTERNAL"
        • Readonly INTERNAL: "INTERNAL"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +HyperlinkType | docx

        Variable HyperlinkTypeConst

        HyperlinkType: {
            EXTERNAL: "EXTERNAL";
            INTERNAL: "INTERNAL";
        } = ...

        Type declaration

        • Readonly EXTERNAL: "EXTERNAL"
        • Readonly INTERNAL: "INTERNAL"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/LeaderType.html b/api/variables/LeaderType.html index 3beed386ed..964cdb1e7d 100644 --- a/api/variables/LeaderType.html +++ b/api/variables/LeaderType.html @@ -1 +1 @@ -LeaderType | docx

        Variable LeaderTypeConst

        LeaderType: {
            DOT: "dot";
            HYPHEN: "hyphen";
            MIDDLE_DOT: "middleDot";
            NONE: "none";
            UNDERSCORE: "underscore";
        } = ...

        Type declaration

        • Readonly DOT: "dot"
        • Readonly HYPHEN: "hyphen"
        • Readonly MIDDLE_DOT: "middleDot"
        • Readonly NONE: "none"
        • Readonly UNDERSCORE: "underscore"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +LeaderType | docx

        Variable LeaderTypeConst

        LeaderType: {
            DOT: "dot";
            HYPHEN: "hyphen";
            MIDDLE_DOT: "middleDot";
            NONE: "none";
            UNDERSCORE: "underscore";
        } = ...

        Type declaration

        • Readonly DOT: "dot"
        • Readonly HYPHEN: "hyphen"
        • Readonly MIDDLE_DOT: "middleDot"
        • Readonly NONE: "none"
        • Readonly UNDERSCORE: "underscore"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/LevelFormat.html b/api/variables/LevelFormat.html index b7fccde9a0..ecbb73835d 100644 --- a/api/variables/LevelFormat.html +++ b/api/variables/LevelFormat.html @@ -1 +1 @@ -LevelFormat | docx

        Variable LevelFormatConst

        LevelFormat: {
            AIUEO: "aiueo";
            AIUEO_FULL_WIDTH: "aiueoFullWidth";
            ARABIC_ABJAD: "arabicAbjad";
            ARABIC_ALPHA: "arabicAlpha";
            BAHT_TEXT: "bahtText";
            BULLET: "bullet";
            CARDINAL_TEXT: "cardinalText";
            CHICAGO: "chicago";
            CHINESE_COUNTING: "chineseCounting";
            CHINESE_COUNTING_THOUSAND: "chineseCountingThousand";
            CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
            CHOSUNG: "chosung";
            CUSTOM: "custom";
            DECIMAL: "decimal";
            DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
            DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
            DECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop";
            DECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen";
            DECIMAL_FULL_WIDTH: "decimalFullWidth";
            DECIMAL_FULL_WIDTH2: "decimalFullWidth2";
            DECIMAL_HALF_WIDTH: "decimalHalfWidth";
            DECIMAL_ZERO: "decimalZero";
            DOLLAR_TEXT: "dollarText";
            GANADA: "ganada";
            HEBREW1: "hebrew1";
            HEBREW2: "hebrew2";
            HEX: "hex";
            HINDI_CONSONANTS: "hindiConsonants";
            HINDI_COUNTING: "hindiCounting";
            HINDI_NUMBERS: "hindiNumbers";
            HINDI_VOWELS: "hindiVowels";
            IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
            IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
            IDEOGRAPH_TRADITIONAL: "ideographTraditional";
            IDEOGRAPH_ZODIAC: "ideographZodiac";
            IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
            IDEOGRAPH__DIGITAL: "ideographDigital";
            IROHA: "iroha";
            IROHA_FULL_WIDTH: "irohaFullWidth";
            JAPANESE_COUNTING: "japaneseCounting";
            JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
            JAPANESE_LEGAL: "japaneseLegal";
            KOREAN_COUNTING: "koreanCounting";
            KOREAN_DIGITAL: "koreanDigital";
            KOREAN_DIGITAL2: "koreanDigital2";
            KOREAN_LEGAL: "koreanLegal";
            LOWER_LETTER: "lowerLetter";
            LOWER_ROMAN: "lowerRoman";
            NONE: "none";
            NUMBER_IN_DASH: "numberInDash";
            ORDINAL: "ordinal";
            ORDINAL_TEXT: "ordinalText";
            RUSSIAN_LOWER: "russianLower";
            RUSSIAN_UPPER: "russianUpper";
            TAIWANESE_COUNTING: "taiwaneseCounting";
            TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
            TAIWANESE_DIGITAL: "taiwaneseDigital";
            THAI_COUNTING: "thaiCounting";
            THAI_LETTERS: "thaiLetters";
            THAI_NUMBERS: "thaiNumbers";
            UPPER_LETTER: "upperLetter";
            UPPER_ROMAN: "upperRoman";
            VIETNAMESE_COUNTING: "vietnameseCounting";
        } = ...

        Type declaration

        • Readonly AIUEO: "aiueo"
        • Readonly AIUEO_FULL_WIDTH: "aiueoFullWidth"
        • Readonly ARABIC_ABJAD: "arabicAbjad"
        • Readonly ARABIC_ALPHA: "arabicAlpha"
        • Readonly BAHT_TEXT: "bahtText"
        • Readonly BULLET: "bullet"
        • Readonly CARDINAL_TEXT: "cardinalText"
        • Readonly CHICAGO: "chicago"
        • Readonly CHINESE_COUNTING: "chineseCounting"
        • Readonly CHINESE_COUNTING_THOUSAND: "chineseCountingThousand"
        • Readonly CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified"
        • Readonly CHOSUNG: "chosung"
        • Readonly CUSTOM: "custom"
        • Readonly DECIMAL: "decimal"
        • Readonly DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle"
        • Readonly DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese"
        • Readonly DECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop"
        • Readonly DECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen"
        • Readonly DECIMAL_FULL_WIDTH: "decimalFullWidth"
        • Readonly DECIMAL_FULL_WIDTH2: "decimalFullWidth2"
        • Readonly DECIMAL_HALF_WIDTH: "decimalHalfWidth"
        • Readonly DECIMAL_ZERO: "decimalZero"
        • Readonly DOLLAR_TEXT: "dollarText"
        • Readonly GANADA: "ganada"
        • Readonly HEBREW1: "hebrew1"
        • Readonly HEBREW2: "hebrew2"
        • Readonly HEX: "hex"
        • Readonly HINDI_CONSONANTS: "hindiConsonants"
        • Readonly HINDI_COUNTING: "hindiCounting"
        • Readonly HINDI_NUMBERS: "hindiNumbers"
        • Readonly HINDI_VOWELS: "hindiVowels"
        • Readonly IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle"
        • Readonly IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional"
        • Readonly IDEOGRAPH_TRADITIONAL: "ideographTraditional"
        • Readonly IDEOGRAPH_ZODIAC: "ideographZodiac"
        • Readonly IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional"
        • Readonly IDEOGRAPH__DIGITAL: "ideographDigital"
        • Readonly IROHA: "iroha"
        • Readonly IROHA_FULL_WIDTH: "irohaFullWidth"
        • Readonly JAPANESE_COUNTING: "japaneseCounting"
        • Readonly JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand"
        • Readonly JAPANESE_LEGAL: "japaneseLegal"
        • Readonly KOREAN_COUNTING: "koreanCounting"
        • Readonly KOREAN_DIGITAL: "koreanDigital"
        • Readonly KOREAN_DIGITAL2: "koreanDigital2"
        • Readonly KOREAN_LEGAL: "koreanLegal"
        • Readonly LOWER_LETTER: "lowerLetter"
        • Readonly LOWER_ROMAN: "lowerRoman"
        • Readonly NONE: "none"
        • Readonly NUMBER_IN_DASH: "numberInDash"
        • Readonly ORDINAL: "ordinal"
        • Readonly ORDINAL_TEXT: "ordinalText"
        • Readonly RUSSIAN_LOWER: "russianLower"
        • Readonly RUSSIAN_UPPER: "russianUpper"
        • Readonly TAIWANESE_COUNTING: "taiwaneseCounting"
        • Readonly TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand"
        • Readonly TAIWANESE_DIGITAL: "taiwaneseDigital"
        • Readonly THAI_COUNTING: "thaiCounting"
        • Readonly THAI_LETTERS: "thaiLetters"
        • Readonly THAI_NUMBERS: "thaiNumbers"
        • Readonly UPPER_LETTER: "upperLetter"
        • Readonly UPPER_ROMAN: "upperRoman"
        • Readonly VIETNAMESE_COUNTING: "vietnameseCounting"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +LevelFormat | docx

        Variable LevelFormatConst

        LevelFormat: {
            AIUEO: "aiueo";
            AIUEO_FULL_WIDTH: "aiueoFullWidth";
            ARABIC_ABJAD: "arabicAbjad";
            ARABIC_ALPHA: "arabicAlpha";
            BAHT_TEXT: "bahtText";
            BULLET: "bullet";
            CARDINAL_TEXT: "cardinalText";
            CHICAGO: "chicago";
            CHINESE_COUNTING: "chineseCounting";
            CHINESE_COUNTING_THOUSAND: "chineseCountingThousand";
            CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
            CHOSUNG: "chosung";
            CUSTOM: "custom";
            DECIMAL: "decimal";
            DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
            DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
            DECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop";
            DECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen";
            DECIMAL_FULL_WIDTH: "decimalFullWidth";
            DECIMAL_FULL_WIDTH2: "decimalFullWidth2";
            DECIMAL_HALF_WIDTH: "decimalHalfWidth";
            DECIMAL_ZERO: "decimalZero";
            DOLLAR_TEXT: "dollarText";
            GANADA: "ganada";
            HEBREW1: "hebrew1";
            HEBREW2: "hebrew2";
            HEX: "hex";
            HINDI_CONSONANTS: "hindiConsonants";
            HINDI_COUNTING: "hindiCounting";
            HINDI_NUMBERS: "hindiNumbers";
            HINDI_VOWELS: "hindiVowels";
            IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
            IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
            IDEOGRAPH_TRADITIONAL: "ideographTraditional";
            IDEOGRAPH_ZODIAC: "ideographZodiac";
            IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
            IDEOGRAPH__DIGITAL: "ideographDigital";
            IROHA: "iroha";
            IROHA_FULL_WIDTH: "irohaFullWidth";
            JAPANESE_COUNTING: "japaneseCounting";
            JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
            JAPANESE_LEGAL: "japaneseLegal";
            KOREAN_COUNTING: "koreanCounting";
            KOREAN_DIGITAL: "koreanDigital";
            KOREAN_DIGITAL2: "koreanDigital2";
            KOREAN_LEGAL: "koreanLegal";
            LOWER_LETTER: "lowerLetter";
            LOWER_ROMAN: "lowerRoman";
            NONE: "none";
            NUMBER_IN_DASH: "numberInDash";
            ORDINAL: "ordinal";
            ORDINAL_TEXT: "ordinalText";
            RUSSIAN_LOWER: "russianLower";
            RUSSIAN_UPPER: "russianUpper";
            TAIWANESE_COUNTING: "taiwaneseCounting";
            TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
            TAIWANESE_DIGITAL: "taiwaneseDigital";
            THAI_COUNTING: "thaiCounting";
            THAI_LETTERS: "thaiLetters";
            THAI_NUMBERS: "thaiNumbers";
            UPPER_LETTER: "upperLetter";
            UPPER_ROMAN: "upperRoman";
            VIETNAMESE_COUNTING: "vietnameseCounting";
        } = ...

        Type declaration

        • Readonly AIUEO: "aiueo"
        • Readonly AIUEO_FULL_WIDTH: "aiueoFullWidth"
        • Readonly ARABIC_ABJAD: "arabicAbjad"
        • Readonly ARABIC_ALPHA: "arabicAlpha"
        • Readonly BAHT_TEXT: "bahtText"
        • Readonly BULLET: "bullet"
        • Readonly CARDINAL_TEXT: "cardinalText"
        • Readonly CHICAGO: "chicago"
        • Readonly CHINESE_COUNTING: "chineseCounting"
        • Readonly CHINESE_COUNTING_THOUSAND: "chineseCountingThousand"
        • Readonly CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified"
        • Readonly CHOSUNG: "chosung"
        • Readonly CUSTOM: "custom"
        • Readonly DECIMAL: "decimal"
        • Readonly DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle"
        • Readonly DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese"
        • Readonly DECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop"
        • Readonly DECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen"
        • Readonly DECIMAL_FULL_WIDTH: "decimalFullWidth"
        • Readonly DECIMAL_FULL_WIDTH2: "decimalFullWidth2"
        • Readonly DECIMAL_HALF_WIDTH: "decimalHalfWidth"
        • Readonly DECIMAL_ZERO: "decimalZero"
        • Readonly DOLLAR_TEXT: "dollarText"
        • Readonly GANADA: "ganada"
        • Readonly HEBREW1: "hebrew1"
        • Readonly HEBREW2: "hebrew2"
        • Readonly HEX: "hex"
        • Readonly HINDI_CONSONANTS: "hindiConsonants"
        • Readonly HINDI_COUNTING: "hindiCounting"
        • Readonly HINDI_NUMBERS: "hindiNumbers"
        • Readonly HINDI_VOWELS: "hindiVowels"
        • Readonly IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle"
        • Readonly IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional"
        • Readonly IDEOGRAPH_TRADITIONAL: "ideographTraditional"
        • Readonly IDEOGRAPH_ZODIAC: "ideographZodiac"
        • Readonly IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional"
        • Readonly IDEOGRAPH__DIGITAL: "ideographDigital"
        • Readonly IROHA: "iroha"
        • Readonly IROHA_FULL_WIDTH: "irohaFullWidth"
        • Readonly JAPANESE_COUNTING: "japaneseCounting"
        • Readonly JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand"
        • Readonly JAPANESE_LEGAL: "japaneseLegal"
        • Readonly KOREAN_COUNTING: "koreanCounting"
        • Readonly KOREAN_DIGITAL: "koreanDigital"
        • Readonly KOREAN_DIGITAL2: "koreanDigital2"
        • Readonly KOREAN_LEGAL: "koreanLegal"
        • Readonly LOWER_LETTER: "lowerLetter"
        • Readonly LOWER_ROMAN: "lowerRoman"
        • Readonly NONE: "none"
        • Readonly NUMBER_IN_DASH: "numberInDash"
        • Readonly ORDINAL: "ordinal"
        • Readonly ORDINAL_TEXT: "ordinalText"
        • Readonly RUSSIAN_LOWER: "russianLower"
        • Readonly RUSSIAN_UPPER: "russianUpper"
        • Readonly TAIWANESE_COUNTING: "taiwaneseCounting"
        • Readonly TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand"
        • Readonly TAIWANESE_DIGITAL: "taiwaneseDigital"
        • Readonly THAI_COUNTING: "thaiCounting"
        • Readonly THAI_LETTERS: "thaiLetters"
        • Readonly THAI_NUMBERS: "thaiNumbers"
        • Readonly UPPER_LETTER: "upperLetter"
        • Readonly UPPER_ROMAN: "upperRoman"
        • Readonly VIETNAMESE_COUNTING: "vietnameseCounting"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/LevelSuffix.html b/api/variables/LevelSuffix.html index c8599be32e..d6bb1baba8 100644 --- a/api/variables/LevelSuffix.html +++ b/api/variables/LevelSuffix.html @@ -1 +1 @@ -LevelSuffix | docx

        Variable LevelSuffixConst

        LevelSuffix: {
            NOTHING: "nothing";
            SPACE: "space";
            TAB: "tab";
        } = ...

        Type declaration

        • Readonly NOTHING: "nothing"
        • Readonly SPACE: "space"
        • Readonly TAB: "tab"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +LevelSuffix | docx

        Variable LevelSuffixConst

        LevelSuffix: {
            NOTHING: "nothing";
            SPACE: "space";
            TAB: "tab";
        } = ...

        Type declaration

        • Readonly NOTHING: "nothing"
        • Readonly SPACE: "space"
        • Readonly TAB: "tab"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/LineNumberRestartFormat.html b/api/variables/LineNumberRestartFormat.html index c159885b1a..b30e919e24 100644 --- a/api/variables/LineNumberRestartFormat.html +++ b/api/variables/LineNumberRestartFormat.html @@ -1 +1 @@ -LineNumberRestartFormat | docx

        Variable LineNumberRestartFormatConst

        LineNumberRestartFormat: {
            CONTINUOUS: "continuous";
            NEW_PAGE: "newPage";
            NEW_SECTION: "newSection";
        } = ...

        Type declaration

        • Readonly CONTINUOUS: "continuous"
        • Readonly NEW_PAGE: "newPage"
        • Readonly NEW_SECTION: "newSection"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +LineNumberRestartFormat | docx

        Variable LineNumberRestartFormatConst

        LineNumberRestartFormat: {
            CONTINUOUS: "continuous";
            NEW_PAGE: "newPage";
            NEW_SECTION: "newSection";
        } = ...

        Type declaration

        • Readonly CONTINUOUS: "continuous"
        • Readonly NEW_PAGE: "newPage"
        • Readonly NEW_SECTION: "newSection"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/LineRuleType.html b/api/variables/LineRuleType.html index 0251406193..399cbad5ee 100644 --- a/api/variables/LineRuleType.html +++ b/api/variables/LineRuleType.html @@ -1 +1 @@ -LineRuleType | docx

        Variable LineRuleTypeConst

        LineRuleType: {
            AT_LEAST: "atLeast";
            AUTO: "auto";
            EXACT: "exact";
            EXACTLY: "exactly";
        } = ...

        Type declaration

        • Readonly AT_LEAST: "atLeast"
        • Readonly AUTO: "auto"
        • Readonly EXACT: "exact"
        • Readonly EXACTLY: "exactly"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +LineRuleType | docx

        Variable LineRuleTypeConst

        LineRuleType: {
            AT_LEAST: "atLeast";
            AUTO: "auto";
            EXACT: "exact";
            EXACTLY: "exactly";
        } = ...

        Type declaration

        • Readonly AT_LEAST: "atLeast"
        • Readonly AUTO: "auto"
        • Readonly EXACT: "exact"
        • Readonly EXACTLY: "exactly"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/NumberFormat.html b/api/variables/NumberFormat.html index e3a2e1cbc6..c70d5e8f14 100644 --- a/api/variables/NumberFormat.html +++ b/api/variables/NumberFormat.html @@ -1 +1 @@ -NumberFormat | docx

        Variable NumberFormatConst

        NumberFormat: {
            AIUEO: "aiueo";
            AIUEO_FULL_WIDTH: "aiueoFullWidth";
            ARABIC_ABJAD: "arabicAbjad";
            ARABIC_ALPHA: "arabicAlpha";
            BAHT_TEXT: "bahtText";
            BULLET: "bullet";
            CARDINAL_TEXT: "cardinalText";
            CHICAGO: "chicago";
            CHINESE_COUNTING: "chineseCounting";
            CHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand";
            CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
            CHOSUNG: "chosung";
            DECIMAL: "decimal";
            DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
            DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
            DECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop";
            DECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen";
            DECIMAL_FULL_WIDTH: "decimalFullWidth";
            DECIMAL_FULL_WIDTH_2: "decimalFullWidth2";
            DECIMAL_HALF_WIDTH: "decimalHalfWidth";
            DECIMAL_ZERO: "decimalZero";
            DOLLAR_TEXT: "dollarText";
            GANADA: "ganada";
            HEBREW_1: "hebrew1";
            HEBREW_2: "hebrew2";
            HEX: "hex";
            HINDI_CONSONANTS: "hindiConsonants";
            HINDI_COUNTING: "hindiCounting";
            HINDI_NUMBERS: "hindiNumbers";
            HINDI_VOWELS: "hindiVowels";
            IDEOGRAPH_DIGITAL: "ideographDigital";
            IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
            IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
            IDEOGRAPH_TRADITIONAL: "ideographTraditional";
            IDEOGRAPH_ZODIAC: "ideographZodiac";
            IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
            IROHA: "iroha";
            IROHA_FULL_WIDTH: "irohaFullWidth";
            JAPANESE_COUNTING: "japaneseCounting";
            JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
            JAPANESE_LEGAL: "japaneseLegal";
            KOREAN_COUNTING: "koreanCounting";
            KOREAN_DIGITAL: "koreanDigital";
            KOREAN_DIGITAL_2: "koreanDigital2";
            KOREAN_LEGAL: "koreanLegal";
            LOWER_LETTER: "lowerLetter";
            LOWER_ROMAN: "lowerRoman";
            NONE: "none";
            NUMBER_IN_DASH: "numberInDash";
            ORDINAL: "ordinal";
            ORDINAL_TEXT: "ordinalText";
            RUSSIAN_LOWER: "russianLower";
            RUSSIAN_UPPER: "russianUpper";
            TAIWANESE_COUNTING: "taiwaneseCounting";
            TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
            TAIWANESE_DIGITAL: "taiwaneseDigital";
            THAI_COUNTING: "thaiCounting";
            THAI_LETTERS: "thaiLetters";
            THAI_NUMBERS: "thaiNumbers";
            UPPER_LETTER: "upperLetter";
            UPPER_ROMAN: "upperRoman";
            VIETNAMESE_COUNTING: "vietnameseCounting";
        } = ...

        Type declaration

        • Readonly AIUEO: "aiueo"
        • Readonly AIUEO_FULL_WIDTH: "aiueoFullWidth"
        • Readonly ARABIC_ABJAD: "arabicAbjad"
        • Readonly ARABIC_ALPHA: "arabicAlpha"
        • Readonly BAHT_TEXT: "bahtText"
        • Readonly BULLET: "bullet"
        • Readonly CARDINAL_TEXT: "cardinalText"
        • Readonly CHICAGO: "chicago"
        • Readonly CHINESE_COUNTING: "chineseCounting"
        • Readonly CHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand"
        • Readonly CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified"
        • Readonly CHOSUNG: "chosung"
        • Readonly DECIMAL: "decimal"
        • Readonly DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle"
        • Readonly DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese"
        • Readonly DECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop"
        • Readonly DECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen"
        • Readonly DECIMAL_FULL_WIDTH: "decimalFullWidth"
        • Readonly DECIMAL_FULL_WIDTH_2: "decimalFullWidth2"
        • Readonly DECIMAL_HALF_WIDTH: "decimalHalfWidth"
        • Readonly DECIMAL_ZERO: "decimalZero"
        • Readonly DOLLAR_TEXT: "dollarText"
        • Readonly GANADA: "ganada"
        • Readonly HEBREW_1: "hebrew1"
        • Readonly HEBREW_2: "hebrew2"
        • Readonly HEX: "hex"
        • Readonly HINDI_CONSONANTS: "hindiConsonants"
        • Readonly HINDI_COUNTING: "hindiCounting"
        • Readonly HINDI_NUMBERS: "hindiNumbers"
        • Readonly HINDI_VOWELS: "hindiVowels"
        • Readonly IDEOGRAPH_DIGITAL: "ideographDigital"
        • Readonly IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle"
        • Readonly IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional"
        • Readonly IDEOGRAPH_TRADITIONAL: "ideographTraditional"
        • Readonly IDEOGRAPH_ZODIAC: "ideographZodiac"
        • Readonly IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional"
        • Readonly IROHA: "iroha"
        • Readonly IROHA_FULL_WIDTH: "irohaFullWidth"
        • Readonly JAPANESE_COUNTING: "japaneseCounting"
        • Readonly JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand"
        • Readonly JAPANESE_LEGAL: "japaneseLegal"
        • Readonly KOREAN_COUNTING: "koreanCounting"
        • Readonly KOREAN_DIGITAL: "koreanDigital"
        • Readonly KOREAN_DIGITAL_2: "koreanDigital2"
        • Readonly KOREAN_LEGAL: "koreanLegal"
        • Readonly LOWER_LETTER: "lowerLetter"
        • Readonly LOWER_ROMAN: "lowerRoman"
        • Readonly NONE: "none"
        • Readonly NUMBER_IN_DASH: "numberInDash"
        • Readonly ORDINAL: "ordinal"
        • Readonly ORDINAL_TEXT: "ordinalText"
        • Readonly RUSSIAN_LOWER: "russianLower"
        • Readonly RUSSIAN_UPPER: "russianUpper"
        • Readonly TAIWANESE_COUNTING: "taiwaneseCounting"
        • Readonly TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand"
        • Readonly TAIWANESE_DIGITAL: "taiwaneseDigital"
        • Readonly THAI_COUNTING: "thaiCounting"
        • Readonly THAI_LETTERS: "thaiLetters"
        • Readonly THAI_NUMBERS: "thaiNumbers"
        • Readonly UPPER_LETTER: "upperLetter"
        • Readonly UPPER_ROMAN: "upperRoman"
        • Readonly VIETNAMESE_COUNTING: "vietnameseCounting"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +NumberFormat | docx

        Variable NumberFormatConst

        NumberFormat: {
            AIUEO: "aiueo";
            AIUEO_FULL_WIDTH: "aiueoFullWidth";
            ARABIC_ABJAD: "arabicAbjad";
            ARABIC_ALPHA: "arabicAlpha";
            BAHT_TEXT: "bahtText";
            BULLET: "bullet";
            CARDINAL_TEXT: "cardinalText";
            CHICAGO: "chicago";
            CHINESE_COUNTING: "chineseCounting";
            CHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand";
            CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
            CHOSUNG: "chosung";
            DECIMAL: "decimal";
            DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
            DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
            DECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop";
            DECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen";
            DECIMAL_FULL_WIDTH: "decimalFullWidth";
            DECIMAL_FULL_WIDTH_2: "decimalFullWidth2";
            DECIMAL_HALF_WIDTH: "decimalHalfWidth";
            DECIMAL_ZERO: "decimalZero";
            DOLLAR_TEXT: "dollarText";
            GANADA: "ganada";
            HEBREW_1: "hebrew1";
            HEBREW_2: "hebrew2";
            HEX: "hex";
            HINDI_CONSONANTS: "hindiConsonants";
            HINDI_COUNTING: "hindiCounting";
            HINDI_NUMBERS: "hindiNumbers";
            HINDI_VOWELS: "hindiVowels";
            IDEOGRAPH_DIGITAL: "ideographDigital";
            IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
            IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
            IDEOGRAPH_TRADITIONAL: "ideographTraditional";
            IDEOGRAPH_ZODIAC: "ideographZodiac";
            IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
            IROHA: "iroha";
            IROHA_FULL_WIDTH: "irohaFullWidth";
            JAPANESE_COUNTING: "japaneseCounting";
            JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
            JAPANESE_LEGAL: "japaneseLegal";
            KOREAN_COUNTING: "koreanCounting";
            KOREAN_DIGITAL: "koreanDigital";
            KOREAN_DIGITAL_2: "koreanDigital2";
            KOREAN_LEGAL: "koreanLegal";
            LOWER_LETTER: "lowerLetter";
            LOWER_ROMAN: "lowerRoman";
            NONE: "none";
            NUMBER_IN_DASH: "numberInDash";
            ORDINAL: "ordinal";
            ORDINAL_TEXT: "ordinalText";
            RUSSIAN_LOWER: "russianLower";
            RUSSIAN_UPPER: "russianUpper";
            TAIWANESE_COUNTING: "taiwaneseCounting";
            TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
            TAIWANESE_DIGITAL: "taiwaneseDigital";
            THAI_COUNTING: "thaiCounting";
            THAI_LETTERS: "thaiLetters";
            THAI_NUMBERS: "thaiNumbers";
            UPPER_LETTER: "upperLetter";
            UPPER_ROMAN: "upperRoman";
            VIETNAMESE_COUNTING: "vietnameseCounting";
        } = ...

        Type declaration

        • Readonly AIUEO: "aiueo"
        • Readonly AIUEO_FULL_WIDTH: "aiueoFullWidth"
        • Readonly ARABIC_ABJAD: "arabicAbjad"
        • Readonly ARABIC_ALPHA: "arabicAlpha"
        • Readonly BAHT_TEXT: "bahtText"
        • Readonly BULLET: "bullet"
        • Readonly CARDINAL_TEXT: "cardinalText"
        • Readonly CHICAGO: "chicago"
        • Readonly CHINESE_COUNTING: "chineseCounting"
        • Readonly CHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand"
        • Readonly CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified"
        • Readonly CHOSUNG: "chosung"
        • Readonly DECIMAL: "decimal"
        • Readonly DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle"
        • Readonly DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese"
        • Readonly DECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop"
        • Readonly DECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen"
        • Readonly DECIMAL_FULL_WIDTH: "decimalFullWidth"
        • Readonly DECIMAL_FULL_WIDTH_2: "decimalFullWidth2"
        • Readonly DECIMAL_HALF_WIDTH: "decimalHalfWidth"
        • Readonly DECIMAL_ZERO: "decimalZero"
        • Readonly DOLLAR_TEXT: "dollarText"
        • Readonly GANADA: "ganada"
        • Readonly HEBREW_1: "hebrew1"
        • Readonly HEBREW_2: "hebrew2"
        • Readonly HEX: "hex"
        • Readonly HINDI_CONSONANTS: "hindiConsonants"
        • Readonly HINDI_COUNTING: "hindiCounting"
        • Readonly HINDI_NUMBERS: "hindiNumbers"
        • Readonly HINDI_VOWELS: "hindiVowels"
        • Readonly IDEOGRAPH_DIGITAL: "ideographDigital"
        • Readonly IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle"
        • Readonly IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional"
        • Readonly IDEOGRAPH_TRADITIONAL: "ideographTraditional"
        • Readonly IDEOGRAPH_ZODIAC: "ideographZodiac"
        • Readonly IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional"
        • Readonly IROHA: "iroha"
        • Readonly IROHA_FULL_WIDTH: "irohaFullWidth"
        • Readonly JAPANESE_COUNTING: "japaneseCounting"
        • Readonly JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand"
        • Readonly JAPANESE_LEGAL: "japaneseLegal"
        • Readonly KOREAN_COUNTING: "koreanCounting"
        • Readonly KOREAN_DIGITAL: "koreanDigital"
        • Readonly KOREAN_DIGITAL_2: "koreanDigital2"
        • Readonly KOREAN_LEGAL: "koreanLegal"
        • Readonly LOWER_LETTER: "lowerLetter"
        • Readonly LOWER_ROMAN: "lowerRoman"
        • Readonly NONE: "none"
        • Readonly NUMBER_IN_DASH: "numberInDash"
        • Readonly ORDINAL: "ordinal"
        • Readonly ORDINAL_TEXT: "ordinalText"
        • Readonly RUSSIAN_LOWER: "russianLower"
        • Readonly RUSSIAN_UPPER: "russianUpper"
        • Readonly TAIWANESE_COUNTING: "taiwaneseCounting"
        • Readonly TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand"
        • Readonly TAIWANESE_DIGITAL: "taiwaneseDigital"
        • Readonly THAI_COUNTING: "thaiCounting"
        • Readonly THAI_LETTERS: "thaiLetters"
        • Readonly THAI_NUMBERS: "thaiNumbers"
        • Readonly UPPER_LETTER: "upperLetter"
        • Readonly UPPER_ROMAN: "upperRoman"
        • Readonly VIETNAMESE_COUNTING: "vietnameseCounting"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/OverlapType.html b/api/variables/OverlapType.html index 3ae3d3992a..b0b0deada4 100644 --- a/api/variables/OverlapType.html +++ b/api/variables/OverlapType.html @@ -1 +1 @@ -OverlapType | docx

        Variable OverlapTypeConst

        OverlapType: {
            NEVER: "never";
            OVERLAP: "overlap";
        } = ...

        Type declaration

        • Readonly NEVER: "never"
        • Readonly OVERLAP: "overlap"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +OverlapType | docx

        Variable OverlapTypeConst

        OverlapType: {
            NEVER: "never";
            OVERLAP: "overlap";
        } = ...

        Type declaration

        • Readonly NEVER: "never"
        • Readonly OVERLAP: "overlap"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/PageBorderDisplay.html b/api/variables/PageBorderDisplay.html index e41b7e103d..7ce0291bff 100644 --- a/api/variables/PageBorderDisplay.html +++ b/api/variables/PageBorderDisplay.html @@ -1 +1 @@ -PageBorderDisplay | docx

        Variable PageBorderDisplayConst

        PageBorderDisplay: {
            ALL_PAGES: "allPages";
            FIRST_PAGE: "firstPage";
            NOT_FIRST_PAGE: "notFirstPage";
        } = ...

        Type declaration

        • Readonly ALL_PAGES: "allPages"
        • Readonly FIRST_PAGE: "firstPage"
        • Readonly NOT_FIRST_PAGE: "notFirstPage"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PageBorderDisplay | docx

        Variable PageBorderDisplayConst

        PageBorderDisplay: {
            ALL_PAGES: "allPages";
            FIRST_PAGE: "firstPage";
            NOT_FIRST_PAGE: "notFirstPage";
        } = ...

        Type declaration

        • Readonly ALL_PAGES: "allPages"
        • Readonly FIRST_PAGE: "firstPage"
        • Readonly NOT_FIRST_PAGE: "notFirstPage"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/PageBorderOffsetFrom.html b/api/variables/PageBorderOffsetFrom.html index 2b6e230b2f..751525fb85 100644 --- a/api/variables/PageBorderOffsetFrom.html +++ b/api/variables/PageBorderOffsetFrom.html @@ -1 +1 @@ -PageBorderOffsetFrom | docx

        Variable PageBorderOffsetFromConst

        PageBorderOffsetFrom: {
            PAGE: "page";
            TEXT: "text";
        } = ...

        Type declaration

        • Readonly PAGE: "page"
        • Readonly TEXT: "text"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PageBorderOffsetFrom | docx

        Variable PageBorderOffsetFromConst

        PageBorderOffsetFrom: {
            PAGE: "page";
            TEXT: "text";
        } = ...

        Type declaration

        • Readonly PAGE: "page"
        • Readonly TEXT: "text"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/PageBorderZOrder.html b/api/variables/PageBorderZOrder.html index 1957f71bc1..db1899ddf2 100644 --- a/api/variables/PageBorderZOrder.html +++ b/api/variables/PageBorderZOrder.html @@ -1 +1 @@ -PageBorderZOrder | docx

        Variable PageBorderZOrderConst

        PageBorderZOrder: {
            BACK: "back";
            FRONT: "front";
        } = ...

        Type declaration

        • Readonly BACK: "back"
        • Readonly FRONT: "front"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PageBorderZOrder | docx

        Variable PageBorderZOrderConst

        PageBorderZOrder: {
            BACK: "back";
            FRONT: "front";
        } = ...

        Type declaration

        • Readonly BACK: "back"
        • Readonly FRONT: "front"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/PageNumber.html b/api/variables/PageNumber.html index 92db19db31..ca70f6fc1e 100644 --- a/api/variables/PageNumber.html +++ b/api/variables/PageNumber.html @@ -1 +1 @@ -PageNumber | docx

        Variable PageNumberConst

        PageNumber: {
            CURRENT: "CURRENT";
            TOTAL_PAGES: "TOTAL_PAGES";
            TOTAL_PAGES_IN_SECTION: "TOTAL_PAGES_IN_SECTION";
        } = ...

        Type declaration

        • Readonly CURRENT: "CURRENT"
        • Readonly TOTAL_PAGES: "TOTAL_PAGES"
        • Readonly TOTAL_PAGES_IN_SECTION: "TOTAL_PAGES_IN_SECTION"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PageNumber | docx

        Variable PageNumberConst

        PageNumber: {
            CURRENT: "CURRENT";
            TOTAL_PAGES: "TOTAL_PAGES";
            TOTAL_PAGES_IN_SECTION: "TOTAL_PAGES_IN_SECTION";
        } = ...

        Type declaration

        • Readonly CURRENT: "CURRENT"
        • Readonly TOTAL_PAGES: "TOTAL_PAGES"
        • Readonly TOTAL_PAGES_IN_SECTION: "TOTAL_PAGES_IN_SECTION"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/PageNumberSeparator.html b/api/variables/PageNumberSeparator.html index d969283d02..3923e500c3 100644 --- a/api/variables/PageNumberSeparator.html +++ b/api/variables/PageNumberSeparator.html @@ -1 +1 @@ -PageNumberSeparator | docx

        Variable PageNumberSeparatorConst

        PageNumberSeparator: {
            COLON: "colon";
            EM_DASH: "emDash";
            EN_DASH: "endash";
            HYPHEN: "hyphen";
            PERIOD: "period";
        } = ...

        Type declaration

        • Readonly COLON: "colon"
        • Readonly EM_DASH: "emDash"
        • Readonly EN_DASH: "endash"
        • Readonly HYPHEN: "hyphen"
        • Readonly PERIOD: "period"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PageNumberSeparator | docx

        Variable PageNumberSeparatorConst

        PageNumberSeparator: {
            COLON: "colon";
            EM_DASH: "emDash";
            EN_DASH: "endash";
            HYPHEN: "hyphen";
            PERIOD: "period";
        } = ...

        Type declaration

        • Readonly COLON: "colon"
        • Readonly EM_DASH: "emDash"
        • Readonly EN_DASH: "endash"
        • Readonly HYPHEN: "hyphen"
        • Readonly PERIOD: "period"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/PageOrientation.html b/api/variables/PageOrientation.html index 720715b017..495f59b9f9 100644 --- a/api/variables/PageOrientation.html +++ b/api/variables/PageOrientation.html @@ -1 +1 @@ -PageOrientation | docx

        Variable PageOrientationConst

        PageOrientation: {
            LANDSCAPE: "landscape";
            PORTRAIT: "portrait";
        } = ...

        Type declaration

        • Readonly LANDSCAPE: "landscape"
        • Readonly PORTRAIT: "portrait"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PageOrientation | docx

        Variable PageOrientationConst

        PageOrientation: {
            LANDSCAPE: "landscape";
            PORTRAIT: "portrait";
        } = ...

        Type declaration

        • Readonly LANDSCAPE: "landscape"
        • Readonly PORTRAIT: "portrait"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/PageTextDirectionType.html b/api/variables/PageTextDirectionType.html index db2d8ca2d8..fbb236a2be 100644 --- a/api/variables/PageTextDirectionType.html +++ b/api/variables/PageTextDirectionType.html @@ -1 +1 @@ -PageTextDirectionType | docx

        Variable PageTextDirectionTypeConst

        PageTextDirectionType: {
            LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
            TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
        } = ...

        Type declaration

        • Readonly LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb"
        • Readonly TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PageTextDirectionType | docx

        Variable PageTextDirectionTypeConst

        PageTextDirectionType: {
            LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
            TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
        } = ...

        Type declaration

        • Readonly LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb"
        • Readonly TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/PatchType.html b/api/variables/PatchType.html index bcb04bc351..a14beb9baf 100644 --- a/api/variables/PatchType.html +++ b/api/variables/PatchType.html @@ -1 +1 @@ -PatchType | docx

        Variable PatchTypeConst

        PatchType: {
            DOCUMENT: "file";
            PARAGRAPH: "paragraph";
        } = ...

        Type declaration

        • Readonly DOCUMENT: "file"
        • Readonly PARAGRAPH: "paragraph"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PatchType | docx

        Variable PatchTypeConst

        PatchType: {
            DOCUMENT: "file";
            PARAGRAPH: "paragraph";
        } = ...

        Type declaration

        • Readonly DOCUMENT: "file"
        • Readonly PARAGRAPH: "paragraph"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/PositionalTabAlignment.html b/api/variables/PositionalTabAlignment.html index df3e07356b..9e9d39e367 100644 --- a/api/variables/PositionalTabAlignment.html +++ b/api/variables/PositionalTabAlignment.html @@ -1 +1 @@ -PositionalTabAlignment | docx

        Variable PositionalTabAlignmentConst

        PositionalTabAlignment: {
            CENTER: "center";
            LEFT: "left";
            RIGHT: "right";
        } = ...

        Type declaration

        • Readonly CENTER: "center"
        • Readonly LEFT: "left"
        • Readonly RIGHT: "right"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PositionalTabAlignment | docx

        Variable PositionalTabAlignmentConst

        PositionalTabAlignment: {
            CENTER: "center";
            LEFT: "left";
            RIGHT: "right";
        } = ...

        Type declaration

        • Readonly CENTER: "center"
        • Readonly LEFT: "left"
        • Readonly RIGHT: "right"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/PositionalTabLeader.html b/api/variables/PositionalTabLeader.html index a4987f8138..2ddd99533e 100644 --- a/api/variables/PositionalTabLeader.html +++ b/api/variables/PositionalTabLeader.html @@ -1 +1 @@ -PositionalTabLeader | docx

        Variable PositionalTabLeaderConst

        PositionalTabLeader: {
            DOT: "dot";
            HYPHEN: "hyphen";
            MIDDLE_DOT: "middleDot";
            NONE: "none";
            UNDERSCORE: "underscore";
        } = ...

        Type declaration

        • Readonly DOT: "dot"
        • Readonly HYPHEN: "hyphen"
        • Readonly MIDDLE_DOT: "middleDot"
        • Readonly NONE: "none"
        • Readonly UNDERSCORE: "underscore"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PositionalTabLeader | docx

        Variable PositionalTabLeaderConst

        PositionalTabLeader: {
            DOT: "dot";
            HYPHEN: "hyphen";
            MIDDLE_DOT: "middleDot";
            NONE: "none";
            UNDERSCORE: "underscore";
        } = ...

        Type declaration

        • Readonly DOT: "dot"
        • Readonly HYPHEN: "hyphen"
        • Readonly MIDDLE_DOT: "middleDot"
        • Readonly NONE: "none"
        • Readonly UNDERSCORE: "underscore"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/PositionalTabRelativeTo.html b/api/variables/PositionalTabRelativeTo.html index fc9385df2e..da20cbe188 100644 --- a/api/variables/PositionalTabRelativeTo.html +++ b/api/variables/PositionalTabRelativeTo.html @@ -1 +1 @@ -PositionalTabRelativeTo | docx

        Variable PositionalTabRelativeToConst

        PositionalTabRelativeTo: {
            INDENT: "indent";
            MARGIN: "margin";
        } = ...

        Type declaration

        • Readonly INDENT: "indent"
        • Readonly MARGIN: "margin"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PositionalTabRelativeTo | docx

        Variable PositionalTabRelativeToConst

        PositionalTabRelativeTo: {
            INDENT: "indent";
            MARGIN: "margin";
        } = ...

        Type declaration

        • Readonly INDENT: "indent"
        • Readonly MARGIN: "margin"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/PrettifyType.html b/api/variables/PrettifyType.html index ae19ff46dd..87b891ba7b 100644 --- a/api/variables/PrettifyType.html +++ b/api/variables/PrettifyType.html @@ -1,2 +1,2 @@ PrettifyType | docx

        Variable PrettifyTypeConst

        PrettifyType: {
            NONE: "";
            WITH_2_BLANKS: " ";
            WITH_4_BLANKS: " ";
            WITH_TAB: "\t";
        } = ...

        Use blanks to prettify

        -

        Type declaration

        • Readonly NONE: ""
        • Readonly WITH_2_BLANKS: " "
        • Readonly WITH_4_BLANKS: " "
        • Readonly WITH_TAB: "\t"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/RelativeHorizontalPosition.html b/api/variables/RelativeHorizontalPosition.html index fd014e0de2..45c12913bb 100644 --- a/api/variables/RelativeHorizontalPosition.html +++ b/api/variables/RelativeHorizontalPosition.html @@ -1 +1 @@ -RelativeHorizontalPosition | docx

        Variable RelativeHorizontalPositionConst

        RelativeHorizontalPosition: {
            CENTER: "center";
            INSIDE: "inside";
            LEFT: "left";
            OUTSIDE: "outside";
            RIGHT: "right";
        } = ...

        Type declaration

        • Readonly CENTER: "center"
        • Readonly INSIDE: "inside"
        • Readonly LEFT: "left"
        • Readonly OUTSIDE: "outside"
        • Readonly RIGHT: "right"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +RelativeHorizontalPosition | docx

        Variable RelativeHorizontalPositionConst

        RelativeHorizontalPosition: {
            CENTER: "center";
            INSIDE: "inside";
            LEFT: "left";
            OUTSIDE: "outside";
            RIGHT: "right";
        } = ...

        Type declaration

        • Readonly CENTER: "center"
        • Readonly INSIDE: "inside"
        • Readonly LEFT: "left"
        • Readonly OUTSIDE: "outside"
        • Readonly RIGHT: "right"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/RelativeVerticalPosition.html b/api/variables/RelativeVerticalPosition.html index de3e75fd5b..9a57d38256 100644 --- a/api/variables/RelativeVerticalPosition.html +++ b/api/variables/RelativeVerticalPosition.html @@ -1 +1 @@ -RelativeVerticalPosition | docx

        Variable RelativeVerticalPositionConst

        RelativeVerticalPosition: {
            BOTTOM: "bottom";
            CENTER: "center";
            INLINE: "inline";
            INSIDE: "inside";
            OUTSIDE: "outside";
            TOP: "top";
        } = ...

        Type declaration

        • Readonly BOTTOM: "bottom"
        • Readonly CENTER: "center"
        • Readonly INLINE: "inline"
        • Readonly INSIDE: "inside"
        • Readonly OUTSIDE: "outside"
        • Readonly TOP: "top"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +RelativeVerticalPosition | docx

        Variable RelativeVerticalPositionConst

        RelativeVerticalPosition: {
            BOTTOM: "bottom";
            CENTER: "center";
            INLINE: "inline";
            INSIDE: "inside";
            OUTSIDE: "outside";
            TOP: "top";
        } = ...

        Type declaration

        • Readonly BOTTOM: "bottom"
        • Readonly CENTER: "center"
        • Readonly INLINE: "inline"
        • Readonly INSIDE: "inside"
        • Readonly OUTSIDE: "outside"
        • Readonly TOP: "top"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/SectionType.html b/api/variables/SectionType.html index d29f9fec98..045df5ce1c 100644 --- a/api/variables/SectionType.html +++ b/api/variables/SectionType.html @@ -1 +1 @@ -SectionType | docx

        Variable SectionTypeConst

        SectionType: {
            CONTINUOUS: "continuous";
            EVEN_PAGE: "evenPage";
            NEXT_COLUMN: "nextColumn";
            NEXT_PAGE: "nextPage";
            ODD_PAGE: "oddPage";
        } = ...

        Type declaration

        • Readonly CONTINUOUS: "continuous"
        • Readonly EVEN_PAGE: "evenPage"
        • Readonly NEXT_COLUMN: "nextColumn"
        • Readonly NEXT_PAGE: "nextPage"
        • Readonly ODD_PAGE: "oddPage"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +SectionType | docx

        Variable SectionTypeConst

        SectionType: {
            CONTINUOUS: "continuous";
            EVEN_PAGE: "evenPage";
            NEXT_COLUMN: "nextColumn";
            NEXT_PAGE: "nextPage";
            ODD_PAGE: "oddPage";
        } = ...

        Type declaration

        • Readonly CONTINUOUS: "continuous"
        • Readonly EVEN_PAGE: "evenPage"
        • Readonly NEXT_COLUMN: "nextColumn"
        • Readonly NEXT_PAGE: "nextPage"
        • Readonly ODD_PAGE: "oddPage"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/ShadingType.html b/api/variables/ShadingType.html index 37eeb560f2..220a29e4ae 100644 --- a/api/variables/ShadingType.html +++ b/api/variables/ShadingType.html @@ -1 +1 @@ -ShadingType | docx

        Variable ShadingTypeConst

        ShadingType: {
            CLEAR: "clear";
            DIAGONAL_CROSS: "diagCross";
            DIAGONAL_STRIPE: "diagStripe";
            HORIZONTAL_CROSS: "horzCross";
            HORIZONTAL_STRIPE: "horzStripe";
            NIL: "nil";
            PERCENT_10: "pct10";
            PERCENT_12: "pct12";
            PERCENT_15: "pct15";
            PERCENT_20: "pct20";
            PERCENT_25: "pct25";
            PERCENT_30: "pct30";
            PERCENT_35: "pct35";
            PERCENT_37: "pct37";
            PERCENT_40: "pct40";
            PERCENT_45: "pct45";
            PERCENT_5: "pct5";
            PERCENT_50: "pct50";
            PERCENT_55: "pct55";
            PERCENT_60: "pct60";
            PERCENT_62: "pct62";
            PERCENT_65: "pct65";
            PERCENT_70: "pct70";
            PERCENT_75: "pct75";
            PERCENT_80: "pct80";
            PERCENT_85: "pct85";
            PERCENT_87: "pct87";
            PERCENT_90: "pct90";
            PERCENT_95: "pct95";
            REVERSE_DIAGONAL_STRIPE: "reverseDiagStripe";
            SOLID: "solid";
            THIN_DIAGONAL_CROSS: "thinDiagCross";
            THIN_DIAGONAL_STRIPE: "thinDiagStripe";
            THIN_HORIZONTAL_CROSS: "thinHorzCross";
            THIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe";
            THIN_VERTICAL_STRIPE: "thinVertStripe";
            VERTICAL_STRIPE: "vertStripe";
        } = ...

        Type declaration

        • Readonly CLEAR: "clear"
        • Readonly DIAGONAL_CROSS: "diagCross"
        • Readonly DIAGONAL_STRIPE: "diagStripe"
        • Readonly HORIZONTAL_CROSS: "horzCross"
        • Readonly HORIZONTAL_STRIPE: "horzStripe"
        • Readonly NIL: "nil"
        • Readonly PERCENT_10: "pct10"
        • Readonly PERCENT_12: "pct12"
        • Readonly PERCENT_15: "pct15"
        • Readonly PERCENT_20: "pct20"
        • Readonly PERCENT_25: "pct25"
        • Readonly PERCENT_30: "pct30"
        • Readonly PERCENT_35: "pct35"
        • Readonly PERCENT_37: "pct37"
        • Readonly PERCENT_40: "pct40"
        • Readonly PERCENT_45: "pct45"
        • Readonly PERCENT_5: "pct5"
        • Readonly PERCENT_50: "pct50"
        • Readonly PERCENT_55: "pct55"
        • Readonly PERCENT_60: "pct60"
        • Readonly PERCENT_62: "pct62"
        • Readonly PERCENT_65: "pct65"
        • Readonly PERCENT_70: "pct70"
        • Readonly PERCENT_75: "pct75"
        • Readonly PERCENT_80: "pct80"
        • Readonly PERCENT_85: "pct85"
        • Readonly PERCENT_87: "pct87"
        • Readonly PERCENT_90: "pct90"
        • Readonly PERCENT_95: "pct95"
        • Readonly REVERSE_DIAGONAL_STRIPE: "reverseDiagStripe"
        • Readonly SOLID: "solid"
        • Readonly THIN_DIAGONAL_CROSS: "thinDiagCross"
        • Readonly THIN_DIAGONAL_STRIPE: "thinDiagStripe"
        • Readonly THIN_HORIZONTAL_CROSS: "thinHorzCross"
        • Readonly THIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe"
        • Readonly THIN_VERTICAL_STRIPE: "thinVertStripe"
        • Readonly VERTICAL_STRIPE: "vertStripe"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +ShadingType | docx

        Variable ShadingTypeConst

        ShadingType: {
            CLEAR: "clear";
            DIAGONAL_CROSS: "diagCross";
            DIAGONAL_STRIPE: "diagStripe";
            HORIZONTAL_CROSS: "horzCross";
            HORIZONTAL_STRIPE: "horzStripe";
            NIL: "nil";
            PERCENT_10: "pct10";
            PERCENT_12: "pct12";
            PERCENT_15: "pct15";
            PERCENT_20: "pct20";
            PERCENT_25: "pct25";
            PERCENT_30: "pct30";
            PERCENT_35: "pct35";
            PERCENT_37: "pct37";
            PERCENT_40: "pct40";
            PERCENT_45: "pct45";
            PERCENT_5: "pct5";
            PERCENT_50: "pct50";
            PERCENT_55: "pct55";
            PERCENT_60: "pct60";
            PERCENT_62: "pct62";
            PERCENT_65: "pct65";
            PERCENT_70: "pct70";
            PERCENT_75: "pct75";
            PERCENT_80: "pct80";
            PERCENT_85: "pct85";
            PERCENT_87: "pct87";
            PERCENT_90: "pct90";
            PERCENT_95: "pct95";
            REVERSE_DIAGONAL_STRIPE: "reverseDiagStripe";
            SOLID: "solid";
            THIN_DIAGONAL_CROSS: "thinDiagCross";
            THIN_DIAGONAL_STRIPE: "thinDiagStripe";
            THIN_HORIZONTAL_CROSS: "thinHorzCross";
            THIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe";
            THIN_VERTICAL_STRIPE: "thinVertStripe";
            VERTICAL_STRIPE: "vertStripe";
        } = ...

        Type declaration

        • Readonly CLEAR: "clear"
        • Readonly DIAGONAL_CROSS: "diagCross"
        • Readonly DIAGONAL_STRIPE: "diagStripe"
        • Readonly HORIZONTAL_CROSS: "horzCross"
        • Readonly HORIZONTAL_STRIPE: "horzStripe"
        • Readonly NIL: "nil"
        • Readonly PERCENT_10: "pct10"
        • Readonly PERCENT_12: "pct12"
        • Readonly PERCENT_15: "pct15"
        • Readonly PERCENT_20: "pct20"
        • Readonly PERCENT_25: "pct25"
        • Readonly PERCENT_30: "pct30"
        • Readonly PERCENT_35: "pct35"
        • Readonly PERCENT_37: "pct37"
        • Readonly PERCENT_40: "pct40"
        • Readonly PERCENT_45: "pct45"
        • Readonly PERCENT_5: "pct5"
        • Readonly PERCENT_50: "pct50"
        • Readonly PERCENT_55: "pct55"
        • Readonly PERCENT_60: "pct60"
        • Readonly PERCENT_62: "pct62"
        • Readonly PERCENT_65: "pct65"
        • Readonly PERCENT_70: "pct70"
        • Readonly PERCENT_75: "pct75"
        • Readonly PERCENT_80: "pct80"
        • Readonly PERCENT_85: "pct85"
        • Readonly PERCENT_87: "pct87"
        • Readonly PERCENT_90: "pct90"
        • Readonly PERCENT_95: "pct95"
        • Readonly REVERSE_DIAGONAL_STRIPE: "reverseDiagStripe"
        • Readonly SOLID: "solid"
        • Readonly THIN_DIAGONAL_CROSS: "thinDiagCross"
        • Readonly THIN_DIAGONAL_STRIPE: "thinDiagStripe"
        • Readonly THIN_HORIZONTAL_CROSS: "thinHorzCross"
        • Readonly THIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe"
        • Readonly THIN_VERTICAL_STRIPE: "thinVertStripe"
        • Readonly VERTICAL_STRIPE: "vertStripe"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/SpaceType.html b/api/variables/SpaceType.html index a804ef70fd..04c30ff699 100644 --- a/api/variables/SpaceType.html +++ b/api/variables/SpaceType.html @@ -1 +1 @@ -SpaceType | docx

        Variable SpaceTypeConst

        SpaceType: {
            DEFAULT: "default";
            PRESERVE: "preserve";
        } = ...

        Type declaration

        • Readonly DEFAULT: "default"
        • Readonly PRESERVE: "preserve"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +SpaceType | docx

        Variable SpaceTypeConst

        SpaceType: {
            DEFAULT: "default";
            PRESERVE: "preserve";
        } = ...

        Type declaration

        • Readonly DEFAULT: "default"
        • Readonly PRESERVE: "preserve"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/TabStopPosition.html b/api/variables/TabStopPosition.html index df5ce6583a..7cb9819057 100644 --- a/api/variables/TabStopPosition.html +++ b/api/variables/TabStopPosition.html @@ -1 +1 @@ -TabStopPosition | docx

        Variable TabStopPositionConst

        TabStopPosition: {
            MAX: 9026;
        } = ...

        Type declaration

        • Readonly MAX: 9026

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +TabStopPosition | docx

        Variable TabStopPositionConst

        TabStopPosition: {
            MAX: 9026;
        } = ...

        Type declaration

        • Readonly MAX: 9026

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/TabStopType.html b/api/variables/TabStopType.html index 9ea95f443d..811527e1d2 100644 --- a/api/variables/TabStopType.html +++ b/api/variables/TabStopType.html @@ -1 +1 @@ -TabStopType | docx

        Variable TabStopTypeConst

        TabStopType: {
            BAR: "bar";
            CENTER: "center";
            CLEAR: "clear";
            DECIMAL: "decimal";
            END: "end";
            LEFT: "left";
            NUM: "num";
            RIGHT: "right";
            START: "start";
        } = ...

        Type declaration

        • Readonly BAR: "bar"
        • Readonly CENTER: "center"
        • Readonly CLEAR: "clear"
        • Readonly DECIMAL: "decimal"
        • Readonly END: "end"
        • Readonly LEFT: "left"
        • Readonly NUM: "num"
        • Readonly RIGHT: "right"
        • Readonly START: "start"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +TabStopType | docx

        Variable TabStopTypeConst

        TabStopType: {
            BAR: "bar";
            CENTER: "center";
            CLEAR: "clear";
            DECIMAL: "decimal";
            END: "end";
            LEFT: "left";
            NUM: "num";
            RIGHT: "right";
            START: "start";
        } = ...

        Type declaration

        • Readonly BAR: "bar"
        • Readonly CENTER: "center"
        • Readonly CLEAR: "clear"
        • Readonly DECIMAL: "decimal"
        • Readonly END: "end"
        • Readonly LEFT: "left"
        • Readonly NUM: "num"
        • Readonly RIGHT: "right"
        • Readonly START: "start"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/TableAnchorType.html b/api/variables/TableAnchorType.html index 765b2ad4c9..6fb65b76eb 100644 --- a/api/variables/TableAnchorType.html +++ b/api/variables/TableAnchorType.html @@ -1 +1 @@ -TableAnchorType | docx

        Variable TableAnchorTypeConst

        TableAnchorType: {
            MARGIN: "margin";
            PAGE: "page";
            TEXT: "text";
        } = ...

        Type declaration

        • Readonly MARGIN: "margin"
        • Readonly PAGE: "page"
        • Readonly TEXT: "text"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +TableAnchorType | docx

        Variable TableAnchorTypeConst

        TableAnchorType: {
            MARGIN: "margin";
            PAGE: "page";
            TEXT: "text";
        } = ...

        Type declaration

        • Readonly MARGIN: "margin"
        • Readonly PAGE: "page"
        • Readonly TEXT: "text"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/TableLayoutType.html b/api/variables/TableLayoutType.html index 58c61336e2..1cb48b7e28 100644 --- a/api/variables/TableLayoutType.html +++ b/api/variables/TableLayoutType.html @@ -1 +1 @@ -TableLayoutType | docx

        Variable TableLayoutTypeConst

        TableLayoutType: {
            AUTOFIT: "autofit";
            FIXED: "fixed";
        } = ...

        Type declaration

        • Readonly AUTOFIT: "autofit"
        • Readonly FIXED: "fixed"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +TableLayoutType | docx

        Variable TableLayoutTypeConst

        TableLayoutType: {
            AUTOFIT: "autofit";
            FIXED: "fixed";
        } = ...

        Type declaration

        • Readonly AUTOFIT: "autofit"
        • Readonly FIXED: "fixed"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/TextDirection.html b/api/variables/TextDirection.html index 8de4471d3e..a1763b6ba0 100644 --- a/api/variables/TextDirection.html +++ b/api/variables/TextDirection.html @@ -1 +1 @@ -TextDirection | docx

        Variable TextDirectionConst

        TextDirection: {
            BOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr";
            LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
            TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
        } = ...

        Type declaration

        • Readonly BOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr"
        • Readonly LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb"
        • Readonly TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +TextDirection | docx

        Variable TextDirectionConst

        TextDirection: {
            BOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr";
            LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
            TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
        } = ...

        Type declaration

        • Readonly BOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr"
        • Readonly LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb"
        • Readonly TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/TextEffect.html b/api/variables/TextEffect.html index 9418761c50..7f3e7b1aea 100644 --- a/api/variables/TextEffect.html +++ b/api/variables/TextEffect.html @@ -1 +1 @@ -TextEffect | docx

        Variable TextEffectConst

        TextEffect: {
            ANTS_BLACK: "antsBlack";
            ANTS_RED: "antsRed";
            BLINK_BACKGROUND: "blinkBackground";
            LIGHTS: "lights";
            NONE: "none";
            SHIMMER: "shimmer";
            SPARKLE: "sparkle";
        } = ...

        Type declaration

        • Readonly ANTS_BLACK: "antsBlack"
        • Readonly ANTS_RED: "antsRed"
        • Readonly BLINK_BACKGROUND: "blinkBackground"
        • Readonly LIGHTS: "lights"
        • Readonly NONE: "none"
        • Readonly SHIMMER: "shimmer"
        • Readonly SPARKLE: "sparkle"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +TextEffect | docx

        Variable TextEffectConst

        TextEffect: {
            ANTS_BLACK: "antsBlack";
            ANTS_RED: "antsRed";
            BLINK_BACKGROUND: "blinkBackground";
            LIGHTS: "lights";
            NONE: "none";
            SHIMMER: "shimmer";
            SPARKLE: "sparkle";
        } = ...

        Type declaration

        • Readonly ANTS_BLACK: "antsBlack"
        • Readonly ANTS_RED: "antsRed"
        • Readonly BLINK_BACKGROUND: "blinkBackground"
        • Readonly LIGHTS: "lights"
        • Readonly NONE: "none"
        • Readonly SHIMMER: "shimmer"
        • Readonly SPARKLE: "sparkle"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/TextWrappingSide.html b/api/variables/TextWrappingSide.html index 4a7a134d26..a4ba249a68 100644 --- a/api/variables/TextWrappingSide.html +++ b/api/variables/TextWrappingSide.html @@ -1 +1 @@ -TextWrappingSide | docx

        Variable TextWrappingSideConst

        TextWrappingSide: {
            BOTH_SIDES: "bothSides";
            LARGEST: "largest";
            LEFT: "left";
            RIGHT: "right";
        } = ...

        Type declaration

        • Readonly BOTH_SIDES: "bothSides"
        • Readonly LARGEST: "largest"
        • Readonly LEFT: "left"
        • Readonly RIGHT: "right"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +TextWrappingSide | docx

        Variable TextWrappingSideConst

        TextWrappingSide: {
            BOTH_SIDES: "bothSides";
            LARGEST: "largest";
            LEFT: "left";
            RIGHT: "right";
        } = ...

        Type declaration

        • Readonly BOTH_SIDES: "bothSides"
        • Readonly LARGEST: "largest"
        • Readonly LEFT: "left"
        • Readonly RIGHT: "right"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/TextWrappingType.html b/api/variables/TextWrappingType.html index 8f20917926..9918c501ec 100644 --- a/api/variables/TextWrappingType.html +++ b/api/variables/TextWrappingType.html @@ -1 +1 @@ -TextWrappingType | docx

        Variable TextWrappingTypeConst

        TextWrappingType: {
            NONE: 0;
            SQUARE: 1;
            TIGHT: 2;
            TOP_AND_BOTTOM: 3;
        } = ...

        Type declaration

        • Readonly NONE: 0
        • Readonly SQUARE: 1
        • Readonly TIGHT: 2
        • Readonly TOP_AND_BOTTOM: 3

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +TextWrappingType | docx

        Variable TextWrappingTypeConst

        TextWrappingType: {
            NONE: 0;
            SQUARE: 1;
            TIGHT: 2;
            TOP_AND_BOTTOM: 3;
        } = ...

        Type declaration

        • Readonly NONE: 0
        • Readonly SQUARE: 1
        • Readonly TIGHT: 2
        • Readonly TOP_AND_BOTTOM: 3

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/UnderlineType.html b/api/variables/UnderlineType.html index 4481b9c7af..392d946090 100644 --- a/api/variables/UnderlineType.html +++ b/api/variables/UnderlineType.html @@ -1 +1 @@ -UnderlineType | docx

        Variable UnderlineTypeConst

        UnderlineType: {
            DASH: "dash";
            DASHDOTDOTHEAVY: "dashDotDotHeavy";
            DASHDOTHEAVY: "dashDotHeavy";
            DASHEDHEAVY: "dashedHeavy";
            DASHLONG: "dashLong";
            DASHLONGHEAVY: "dashLongHeavy";
            DOTDASH: "dotDash";
            DOTDOTDASH: "dotDotDash";
            DOTTED: "dotted";
            DOTTEDHEAVY: "dottedHeavy";
            DOUBLE: "double";
            NONE: "none";
            SINGLE: "single";
            THICK: "thick";
            WAVE: "wave";
            WAVYDOUBLE: "wavyDouble";
            WAVYHEAVY: "wavyHeavy";
            WORDS: "words";
        } = ...

        Type declaration

        • Readonly DASH: "dash"
        • Readonly DASHDOTDOTHEAVY: "dashDotDotHeavy"
        • Readonly DASHDOTHEAVY: "dashDotHeavy"
        • Readonly DASHEDHEAVY: "dashedHeavy"
        • Readonly DASHLONG: "dashLong"
        • Readonly DASHLONGHEAVY: "dashLongHeavy"
        • Readonly DOTDASH: "dotDash"
        • Readonly DOTDOTDASH: "dotDotDash"
        • Readonly DOTTED: "dotted"
        • Readonly DOTTEDHEAVY: "dottedHeavy"
        • Readonly DOUBLE: "double"
        • Readonly NONE: "none"
        • Readonly SINGLE: "single"
        • Readonly THICK: "thick"
        • Readonly WAVE: "wave"
        • Readonly WAVYDOUBLE: "wavyDouble"
        • Readonly WAVYHEAVY: "wavyHeavy"
        • Readonly WORDS: "words"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +UnderlineType | docx

        Variable UnderlineTypeConst

        UnderlineType: {
            DASH: "dash";
            DASHDOTDOTHEAVY: "dashDotDotHeavy";
            DASHDOTHEAVY: "dashDotHeavy";
            DASHEDHEAVY: "dashedHeavy";
            DASHLONG: "dashLong";
            DASHLONGHEAVY: "dashLongHeavy";
            DOTDASH: "dotDash";
            DOTDOTDASH: "dotDotDash";
            DOTTED: "dotted";
            DOTTEDHEAVY: "dottedHeavy";
            DOUBLE: "double";
            NONE: "none";
            SINGLE: "single";
            THICK: "thick";
            WAVE: "wave";
            WAVYDOUBLE: "wavyDouble";
            WAVYHEAVY: "wavyHeavy";
            WORDS: "words";
        } = ...

        Type declaration

        • Readonly DASH: "dash"
        • Readonly DASHDOTDOTHEAVY: "dashDotDotHeavy"
        • Readonly DASHDOTHEAVY: "dashDotHeavy"
        • Readonly DASHEDHEAVY: "dashedHeavy"
        • Readonly DASHLONG: "dashLong"
        • Readonly DASHLONGHEAVY: "dashLongHeavy"
        • Readonly DOTDASH: "dotDash"
        • Readonly DOTDOTDASH: "dotDotDash"
        • Readonly DOTTED: "dotted"
        • Readonly DOTTEDHEAVY: "dottedHeavy"
        • Readonly DOUBLE: "double"
        • Readonly NONE: "none"
        • Readonly SINGLE: "single"
        • Readonly THICK: "thick"
        • Readonly WAVE: "wave"
        • Readonly WAVYDOUBLE: "wavyDouble"
        • Readonly WAVYHEAVY: "wavyHeavy"
        • Readonly WORDS: "words"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/VerticalAlign.html b/api/variables/VerticalAlign.html index 641be612e1..4d09ac685a 100644 --- a/api/variables/VerticalAlign.html +++ b/api/variables/VerticalAlign.html @@ -1 +1 @@ -VerticalAlign | docx

        Variable VerticalAlignConst

        VerticalAlign: {
            BOTTOM: "bottom";
            CENTER: "center";
            TOP: "top";
        } = ...

        Type declaration

        • Readonly BOTTOM: "bottom"
        • Readonly CENTER: "center"
        • Readonly TOP: "top"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +VerticalAlign | docx

        Variable VerticalAlignConst

        VerticalAlign: {
            BOTTOM: "bottom";
            CENTER: "center";
            TOP: "top";
        } = ...

        Type declaration

        • Readonly BOTTOM: "bottom"
        • Readonly CENTER: "center"
        • Readonly TOP: "top"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/VerticalMergeType.html b/api/variables/VerticalMergeType.html index 4eb2d91b25..926a75ff0d 100644 --- a/api/variables/VerticalMergeType.html +++ b/api/variables/VerticalMergeType.html @@ -1,4 +1,4 @@ VerticalMergeType | docx

        Variable VerticalMergeTypeConst

        VerticalMergeType: {
            CONTINUE: "continue";
            RESTART: "restart";
        } = ...

        Vertical merge types.

        Type declaration

        • Readonly CONTINUE: "continue"

          Cell that is merged with upper one.

        • Readonly RESTART: "restart"

          Cell that is starting the vertical merge.

          -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/VerticalPositionAlign.html b/api/variables/VerticalPositionAlign.html index 339239babd..dc9c8a9c14 100644 --- a/api/variables/VerticalPositionAlign.html +++ b/api/variables/VerticalPositionAlign.html @@ -1 +1 @@ -VerticalPositionAlign | docx

        Variable VerticalPositionAlignConst

        VerticalPositionAlign: {
            BOTTOM: "bottom";
            CENTER: "center";
            INSIDE: "inside";
            OUTSIDE: "outside";
            TOP: "top";
        } = ...

        Type declaration

        • Readonly BOTTOM: "bottom"
        • Readonly CENTER: "center"
        • Readonly INSIDE: "inside"
        • Readonly OUTSIDE: "outside"
        • Readonly TOP: "top"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +VerticalPositionAlign | docx

        Variable VerticalPositionAlignConst

        VerticalPositionAlign: {
            BOTTOM: "bottom";
            CENTER: "center";
            INSIDE: "inside";
            OUTSIDE: "outside";
            TOP: "top";
        } = ...

        Type declaration

        • Readonly BOTTOM: "bottom"
        • Readonly CENTER: "center"
        • Readonly INSIDE: "inside"
        • Readonly OUTSIDE: "outside"
        • Readonly TOP: "top"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/VerticalPositionRelativeFrom.html b/api/variables/VerticalPositionRelativeFrom.html index 133ac32102..458ce8fc98 100644 --- a/api/variables/VerticalPositionRelativeFrom.html +++ b/api/variables/VerticalPositionRelativeFrom.html @@ -1 +1 @@ -VerticalPositionRelativeFrom | docx

        Variable VerticalPositionRelativeFromConst

        VerticalPositionRelativeFrom: {
            BOTTOM_MARGIN: "bottomMargin";
            INSIDE_MARGIN: "insideMargin";
            LINE: "line";
            MARGIN: "margin";
            OUTSIDE_MARGIN: "outsideMargin";
            PAGE: "page";
            PARAGRAPH: "paragraph";
            TOP_MARGIN: "topMargin";
        } = ...

        Type declaration

        • Readonly BOTTOM_MARGIN: "bottomMargin"
        • Readonly INSIDE_MARGIN: "insideMargin"
        • Readonly LINE: "line"
        • Readonly MARGIN: "margin"
        • Readonly OUTSIDE_MARGIN: "outsideMargin"
        • Readonly PAGE: "page"
        • Readonly PARAGRAPH: "paragraph"
        • Readonly TOP_MARGIN: "topMargin"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +VerticalPositionRelativeFrom | docx

        Variable VerticalPositionRelativeFromConst

        VerticalPositionRelativeFrom: {
            BOTTOM_MARGIN: "bottomMargin";
            INSIDE_MARGIN: "insideMargin";
            LINE: "line";
            MARGIN: "margin";
            OUTSIDE_MARGIN: "outsideMargin";
            PAGE: "page";
            PARAGRAPH: "paragraph";
            TOP_MARGIN: "topMargin";
        } = ...

        Type declaration

        • Readonly BOTTOM_MARGIN: "bottomMargin"
        • Readonly INSIDE_MARGIN: "insideMargin"
        • Readonly LINE: "line"
        • Readonly MARGIN: "margin"
        • Readonly OUTSIDE_MARGIN: "outsideMargin"
        • Readonly PAGE: "page"
        • Readonly PARAGRAPH: "paragraph"
        • Readonly TOP_MARGIN: "topMargin"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/WidthType.html b/api/variables/WidthType.html index ed1eca43ec..8f8abc2b95 100644 --- a/api/variables/WidthType.html +++ b/api/variables/WidthType.html @@ -2,4 +2,4 @@
      • Readonly DXA: "dxa"

        Value is in twentieths of a point

      • Readonly NIL: "nil"

        No (empty) value.

      • Readonly PERCENTAGE: "pct"

        Value is in percentage.

        -

        • Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/sectionMarginDefaults.html b/api/variables/sectionMarginDefaults.html index 2b67a38df5..ec37b1beec 100644 --- a/api/variables/sectionMarginDefaults.html +++ b/api/variables/sectionMarginDefaults.html @@ -1 +1 @@ -sectionMarginDefaults | docx

        Variable sectionMarginDefaultsConst

        sectionMarginDefaults: {
            BOTTOM: number;
            FOOTER: number;
            GUTTER: number;
            HEADER: number;
            LEFT: number;
            RIGHT: number;
            TOP: number;
        } = ...

        Type declaration

        • BOTTOM: number
        • FOOTER: number
        • GUTTER: number
        • HEADER: number
        • LEFT: number
        • RIGHT: number
        • TOP: number

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +sectionMarginDefaults | docx

        Variable sectionMarginDefaultsConst

        sectionMarginDefaults: {
            BOTTOM: number;
            FOOTER: number;
            GUTTER: number;
            HEADER: number;
            LEFT: number;
            RIGHT: number;
            TOP: number;
        } = ...

        Type declaration

        • BOTTOM: number
        • FOOTER: number
        • GUTTER: number
        • HEADER: number
        • LEFT: number
        • RIGHT: number
        • TOP: number

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/api/variables/sectionPageSizeDefaults.html b/api/variables/sectionPageSizeDefaults.html index 7241933cd1..4f14ea34bf 100644 --- a/api/variables/sectionPageSizeDefaults.html +++ b/api/variables/sectionPageSizeDefaults.html @@ -1 +1 @@ -sectionPageSizeDefaults | docx

        Variable sectionPageSizeDefaultsConst

        sectionPageSizeDefaults: {
            HEIGHT: number;
            ORIENTATION: "portrait";
            WIDTH: number;
        } = ...

        Type declaration

        • HEIGHT: number
        • ORIENTATION: "portrait"
        • WIDTH: number

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +sectionPageSizeDefaults | docx

        Variable sectionPageSizeDefaultsConst

        sectionPageSizeDefaults: {
            HEIGHT: number;
            ORIENTATION: "portrait";
            WIDTH: number;
        } = ...

        Type declaration

        • HEIGHT: number
        • ORIENTATION: "portrait"
        • WIDTH: number

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file