diff --git a/api/assets/style.css b/api/assets/style.css index 958d2c263e..e5093854c3 100644 --- a/api/assets/style.css +++ b/api/assets/style.css @@ -825,6 +825,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { padding-left: 5.5rem; } +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + a.tsd-index-link { margin: 0.25rem 0; font-size: 1rem; @@ -978,7 +987,8 @@ a.tsd-index-link { right: -40px; } #tsd-search .field input, -#tsd-search .title { +#tsd-search .title, +#tsd-toolbar-links a { transition: opacity 0.2s; } #tsd-search .results { @@ -1022,7 +1032,8 @@ a.tsd-index-link { top: 0; opacity: 1; } -#tsd-search.has-focus .title { +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { z-index: 0; opacity: 0; } @@ -1036,6 +1047,22 @@ a.tsd-index-link { display: block; } +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + .tsd-signature { margin: 0 0 1rem 0; padding: 1rem 0.5rem; @@ -1134,6 +1161,11 @@ ul.tsd-type-parameter-list h5 { .tsd-page-toolbar .table-cell:first-child { width: 100%; } +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} .tsd-page-toolbar--hide { transform: translateY(-100%); diff --git a/api/classes/AbstractNumbering.html b/api/classes/AbstractNumbering.html index 796efd5aca..7ef380560f 100644 --- a/api/classes/AbstractNumbering.html +++ b/api/classes/AbstractNumbering.html @@ -1,11 +1,13 @@ AbstractNumbering | docx
-
+
  • The search index is not available
  • docx +
    @@ -20,7 +22,7 @@
    • AbstractNumbering
    +
  • Defined in src/file/numbering/abstract-numbering.ts:32
  • @@ -56,14 +58,14 @@

    Returns AbstractNumbering

    +
  • Defined in src/file/numbering/abstract-numbering.ts:35
  • Properties

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

    @@ -79,7 +81,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -16,11 +18,11 @@

    Hierarchy

    +
  • Defined in src/file/paragraph/formatting/alignment.ts:16
  • @@ -39,20 +41,20 @@
    +
  • Defined in src/file/xml-components/default-attributes.ts:11
  • Methods

    @@ -68,7 +70,7 @@

    Returns IXmlableObject

    +
  • Defined in src/file/xml-components/default-attributes.ts:16
  • @@ -16,11 +18,11 @@

    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 }> +
    • 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
    +
  • Defined in src/file/xml-components/attributes.ts:3
  • @@ -39,13 +41,13 @@
      - +
    • Parameters

      • -
        properties: { 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 }
        +
        properties: {
            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;
        }
    +
  • Defined in src/file/xml-components/default-attributes.ts:11
  • Methods

    @@ -106,7 +108,7 @@

    Returns IXmlableObject

    +
  • Defined in src/file/xml-components/default-attributes.ts:16
  • @@ -21,7 +23,7 @@
  • XmlComponent
  • XmlAttributeComponent
  • +
  • Defined in src/file/xml-components/base.ts:10
  • @@ -49,7 +51,7 @@
    rootKey: string

    Returns BaseXmlComponent

    +
  • Defined in src/file/xml-components/base.ts:13
  • Methods

    @@ -64,7 +66,7 @@
    context: IContext

    Returns undefined | IXmlableObject

    +
  • Defined in src/file/xml-components/base.ts:17
  • @@ -20,7 +22,7 @@
    • Body
    +
  • Defined in src/file/document/body/body.ts:6
  • @@ -47,7 +49,7 @@

    Returns Body

    +
  • Defined in src/file/document/body/body.ts:10
  • Methods

    @@ -63,7 +65,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
    • @@ -86,7 +88,7 @@ The spec says:

    Returns void

    +
  • Defined in src/file/document/body/body.ts:23
  • +
  • Defined in src/file/document/body/body.ts:30
  • Returns void

    +
  • Defined in src/file/document/body/body.ts:39
  • @@ -18,7 +20,7 @@
    • Bookmark
    +
  • Defined in src/file/paragraph/links/bookmark.ts:8
  • @@ -39,13 +41,13 @@
    +
  • Defined in src/file/paragraph/links/bookmark.ts:13
  • Properties

    children: readonly ParagraphChild[]
    +
  • Defined in src/file/paragraph/links/bookmark.ts:10
  • +
  • Defined in src/file/paragraph/links/bookmark.ts:11
  • +
  • Defined in src/file/paragraph/links/bookmark.ts:9
  • @@ -20,7 +22,7 @@
    • BookmarkEnd
    +
  • Defined in src/file/paragraph/links/bookmark.ts:66
  • @@ -50,7 +52,7 @@

    Returns BookmarkEnd

    +
  • Defined in src/file/paragraph/links/bookmark.ts:67
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • BookmarkStart
    +
  • Defined in src/file/paragraph/links/bookmark.ts:54
  • @@ -52,7 +54,7 @@

    Returns BookmarkStart

    +
  • Defined in src/file/paragraph/links/bookmark.ts:55
  • Methods

    @@ -68,7 +70,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • BorderElement
    +
  • Defined in src/file/border/border.ts:35
  • @@ -52,7 +54,7 @@

    Returns BorderElement

    +
  • Defined in src/file/border/border.ts:36
  • Methods

    @@ -68,7 +70,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • ColumnBreak
    +
  • Defined in src/file/paragraph/formatting/break.ts:29
  • @@ -45,7 +47,7 @@

    Returns ColumnBreak

    +
  • Defined in src/file/paragraph/formatting/break.ts:30
  • Methods

    @@ -61,7 +63,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • CommentRangeStart
    +
  • Defined in src/file/paragraph/run/comment-run.ts:98
  • @@ -50,7 +52,7 @@

    Returns CommentRangeStart

    +
  • Defined in src/file/paragraph/run/comment-run.ts:99
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • ConcreteNumbering
    +
  • Defined in src/file/numbering/num.ts:43
  • @@ -56,24 +58,24 @@

    Returns ConcreteNumbering

    +
  • Defined in src/file/numbering/num.ts:48
  • Properties

    instance: number
    +
  • Defined in src/file/numbering/num.ts:46
  • numId: number
    +
  • Defined in src/file/numbering/num.ts:44
  • reference: string
    +
  • Defined in src/file/numbering/num.ts:45
  • Methods

    @@ -89,7 +91,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -18,7 +20,7 @@
    • Document
    +
  • Defined in src/file/file.ts:39
  • @@ -61,7 +63,7 @@
    fileProperties: IFileProperties = {}

    Returns Document

    +
  • Defined in src/file/file.ts:60
  • Accessors

    @@ -71,7 +73,7 @@
  • Returns AppProperties

  • +
  • Defined in src/file/file.ts:298
  • +
  • Defined in src/file/file.ts:310
  • +
  • Defined in src/file/file.ts:290
  • +
  • Defined in src/file/file.ts:266
  • +
  • Defined in src/file/file.ts:294
  • +
  • Defined in src/file/file.ts:258
  • +
  • Defined in src/file/file.ts:278
  • +
  • Defined in src/file/file.ts:302
  • +
  • Defined in src/file/file.ts:286
  • +
  • Defined in src/file/file.ts:282
  • +
  • Defined in src/file/file.ts:274
  • +
  • Defined in src/file/file.ts:270
  • +
  • Defined in src/file/file.ts:306
  • +
  • Defined in src/file/file.ts:262
  • @@ -16,11 +18,11 @@

    Hierarchy

      -
    • XmlAttributeComponent<{ color?: string; themeColor?: string; themeShade?: string; themeTint?: string }> +
    • XmlAttributeComponent<{
          color?: string;
          themeColor?: string;
          themeShade?: string;
          themeTint?: string;
      }>
      • DocumentBackgroundAttributes
    +
  • Defined in src/file/document/document-background/document-background.ts:28
  • @@ -39,13 +41,13 @@
    +
  • Defined in src/file/xml-components/default-attributes.ts:11
  • Methods

    @@ -74,7 +76,7 @@

    Returns IXmlableObject

    +
  • Defined in src/file/xml-components/default-attributes.ts:16
  • @@ -20,7 +22,7 @@
    • DotEmphasisMark
    +
  • Defined in src/file/paragraph/run/emphasis-mark.ts:24
  • @@ -45,7 +47,7 @@

    Returns DotEmphasisMark

    +
  • Defined in src/file/paragraph/run/emphasis-mark.ts:25
  • Methods

    @@ -61,7 +63,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • Drawing
    +
  • Defined in src/file/drawing/drawing.ts:25
  • @@ -52,7 +54,7 @@

    Returns Drawing

    +
  • Defined in src/file/drawing/drawing.ts:28
  • Methods

    @@ -68,7 +70,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • EmphasisMark
    +
  • Defined in src/file/paragraph/run/emphasis-mark.ts:18
  • @@ -50,7 +52,7 @@

    Returns EmphasisMark

    +
  • Defined in src/file/paragraph/run/emphasis-mark.ts:19
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • ExternalHyperlink
    +
  • Defined in src/file/paragraph/links/hyperlink.ts:41
  • @@ -44,13 +46,13 @@
    +
  • Defined in src/file/paragraph/links/hyperlink.ts:42
  • Properties

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

    Type declaration

      @@ -73,7 +75,7 @@
    • Readonly link: string
    +
  • Defined in src/file/paragraph/links/hyperlink.ts:42
  • Methods

    @@ -89,7 +91,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -16,11 +18,11 @@

    Hierarchy

    +
  • Defined in src/file/footnotes/footnote/run/reference-run.ts:4
  • @@ -39,20 +41,20 @@
    +
  • Defined in src/file/xml-components/default-attributes.ts:11
  • Methods

    @@ -68,7 +70,7 @@

    Returns IXmlableObject

    +
  • Defined in src/file/xml-components/default-attributes.ts:16
  • @@ -20,7 +22,7 @@
    • FootNotes
    +
  • Defined in src/file/footnotes/footnotes.ts:9
  • @@ -46,7 +48,7 @@

    Returns FootNotes

    +
  • Defined in src/file/footnotes/footnotes.ts:10
  • Methods

    @@ -62,7 +64,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
    • @@ -77,7 +79,7 @@
      paragraph: readonly Paragraph[]

    Returns void

    +
  • Defined in src/file/footnotes/footnotes.ts:70
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -18,7 +20,7 @@
    • Footer
    +
  • Defined in src/file/header.ts:16
  • @@ -46,14 +48,14 @@
    options: IHeaderOptions = ...

    Returns Footer

    +
  • Defined in src/file/header.ts:19
  • Properties

    +
  • Defined in src/file/header.ts:17
  • @@ -22,7 +24,7 @@
    • IViewWrapper
    +
  • Defined in src/file/footer-wrapper.ts:16
  • @@ -61,7 +63,7 @@
    Optional initContent: XmlComponent

    Returns FooterWrapper

    +
  • Defined in src/file/footer-wrapper.ts:20
  • Accessors

    @@ -71,7 +73,7 @@
  • Returns Media

  • +
  • Defined in src/file/footer-wrapper.ts:41
  • +
  • Defined in src/file/footer-wrapper.ts:37
  • +
  • Defined in src/file/footer-wrapper.ts:33
  • Methods

    @@ -104,7 +106,7 @@
    item: Paragraph | Table

    Returns void

    +
  • Defined in src/file/footer-wrapper.ts:25
  • Returns void

    +
  • Defined in src/file/footer-wrapper.ts:29
  • @@ -16,11 +18,11 @@

    Hierarchy

    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:63
  • @@ -39,13 +41,13 @@
    +
  • Defined in src/file/xml-components/default-attributes.ts:11
  • Methods

    @@ -96,7 +98,7 @@

    Returns IXmlableObject

    +
  • Defined in src/file/xml-components/default-attributes.ts:16
  • @@ -18,7 +20,7 @@
    • Header
    +
  • Defined in src/file/header.ts:8
  • @@ -46,14 +48,14 @@
    options: IHeaderOptions = ...

    Returns Header

    +
  • Defined in src/file/header.ts:11
  • Properties

    +
  • Defined in src/file/header.ts:9
  • @@ -22,7 +24,7 @@
    • IViewWrapper
    +
  • Defined in src/file/header-wrapper.ts:16
  • @@ -61,7 +63,7 @@
    Optional initContent: XmlComponent

    Returns HeaderWrapper

    +
  • Defined in src/file/header-wrapper.ts:20
  • Accessors

    @@ -71,7 +73,7 @@
  • Returns Media

  • +
  • Defined in src/file/header-wrapper.ts:43
  • +
  • Defined in src/file/header-wrapper.ts:39
  • +
  • Defined in src/file/header-wrapper.ts:35
  • Methods

    @@ -104,7 +106,7 @@
    item: Paragraph | Table

    Returns HeaderWrapper

    +
  • Defined in src/file/header-wrapper.ts:25
  • Returns void

    +
  • Defined in src/file/header-wrapper.ts:31
  • @@ -20,7 +22,7 @@
    • ImageRun
    +
  • Defined in src/file/paragraph/run/image-run.ts:16
  • @@ -50,7 +52,7 @@

    Returns ImageRun

    +
  • Defined in src/file/paragraph/run/image-run.ts:20
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/paragraph/run/image-run.ts:45
  • @@ -18,7 +20,7 @@
    • ImportDotx
    +
  • Defined in src/import-dotx/import-dotx.ts:49
  • @@ -54,7 +56,7 @@
    data: string | number[] | ArrayBuffer | Uint8Array | Blob | Buffer | ReadableStream

    Returns Promise<IDocumentTemplate>

    +
  • Defined in src/import-dotx/import-dotx.ts:50
  • @@ -23,7 +25,7 @@
    • ImportedXmlComponent
    +
  • Defined in src/file/xml-components/imported-xml-component.ts:43
  • @@ -59,7 +61,7 @@

    Returns ImportedXmlComponent

    +
  • Defined in src/file/xml-components/imported-xml-component.ts:60
  • Methods

    @@ -75,7 +77,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • Returns void

    +
  • Defined in src/file/xml-components/imported-xml-component.ts:67
    • @@ -119,7 +121,7 @@

    Returns ImportedXmlComponent

    +
  • Defined in src/file/xml-components/imported-xml-component.ts:49
  • @@ -20,7 +22,7 @@
    • InternalHyperlink
    +
  • Defined in src/file/paragraph/links/hyperlink.ts:35
  • @@ -44,13 +46,13 @@
    +
  • Defined in src/file/paragraph/links/hyperlink.ts:36
  • Properties

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

    @@ -83,7 +85,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • Level
    +
  • Defined in src/file/numbering/level.ts:202
  • @@ -50,7 +52,7 @@

    Returns Level

    +
  • Defined in src/file/numbering/level.ts:149
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • LevelForOverride
    +
  • Defined in src/file/numbering/level.ts:207
  • @@ -50,7 +52,7 @@

    Returns LevelForOverride

    +
  • Defined in src/file/numbering/level.ts:149
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • LevelOverride
    +
  • Defined in src/file/numbering/num.ts:73
  • @@ -52,7 +54,7 @@

    Returns LevelOverride

    +
  • Defined in src/file/numbering/num.ts:74
  • Methods

    @@ -68,7 +70,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • Math
    +
  • Defined in src/file/paragraph/math/math.ts:10
  • @@ -50,7 +52,7 @@

    Returns Math

    +
  • Defined in src/file/paragraph/math/math.ts:11
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • MathAngledBrackets
    +
  • Defined in src/file/paragraph/math/brackets/math-angled-brackets.ts:8
  • @@ -40,20 +42,20 @@
    +
  • Defined in src/file/paragraph/math/brackets/math-angled-brackets.ts:9
  • Methods

    @@ -69,7 +71,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • MathCurlyBrackets
    +
  • Defined in src/file/paragraph/math/brackets/math-curly-brackets.ts:8
  • @@ -40,20 +42,20 @@
    +
  • Defined in src/file/paragraph/math/brackets/math-curly-brackets.ts:9
  • Methods

    @@ -69,7 +71,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • MathRoundBrackets
    +
  • Defined in src/file/paragraph/math/brackets/math-round-brackets.ts:8
  • @@ -40,20 +42,20 @@
    +
  • Defined in src/file/paragraph/math/brackets/math-round-brackets.ts:9
  • Methods

    @@ -69,7 +71,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • MathRun
    +
  • Defined in src/file/paragraph/math/math-run.ts:6
  • @@ -50,7 +52,7 @@

    Returns MathRun

    +
  • Defined in src/file/paragraph/math/math-run.ts:7
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • MathSquareBrackets
    +
  • Defined in src/file/paragraph/math/brackets/math-square-brackets.ts:8
  • @@ -40,20 +42,20 @@
    +
  • Defined in src/file/paragraph/math/brackets/math-square-brackets.ts:9
  • Methods

    @@ -69,7 +71,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -18,7 +20,7 @@
    • Media
    +
  • Defined in src/file/media/media.ts:15
  • @@ -46,7 +48,7 @@
  • Returns Media

  • +
  • Defined in src/file/media/media.ts:19
  • Accessors

    @@ -56,7 +58,7 @@
  • Returns readonly IMediaData[]

  • +
  • Defined in src/file/media/media.ts:54
  • Methods

    @@ -73,7 +75,7 @@
    mediaData: IMediaData

    Returns void

    +
  • Defined in src/file/media/media.ts:50
  • Returns IMediaData

    +
  • Defined in src/file/media/media.ts:23
  • @@ -20,7 +22,7 @@
    • Numbering
    +
  • Defined in src/file/numbering/numbering.ts:29
  • @@ -56,7 +58,7 @@

    Returns Numbering

    +
  • Defined in src/file/numbering/numbering.ts:34
  • Accessors

    @@ -66,7 +68,7 @@
  • Returns readonly ConcreteNumbering[]

  • +
  • Defined in src/file/numbering/numbering.ts:229
  • +
  • Defined in src/file/numbering/numbering.ts:232
  • Methods

    @@ -90,7 +92,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
    • @@ -105,7 +107,7 @@
      instance: number

    Returns void

    +
  • Defined in src/file/numbering/numbering.ts:193
  • +
  • Defined in src/file/numbering/numbering.ts:182
  • @@ -20,7 +22,7 @@
    • OutlineLevel
    +
  • Defined in src/file/paragraph/links/outline-level.ts:4
  • @@ -54,14 +56,14 @@

    Returns OutlineLevel

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

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

    @@ -77,7 +79,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -18,7 +20,7 @@
    • Packer
    +
  • Defined in src/export/packer/packer.ts:16
  • @@ -60,7 +62,7 @@
    Optional prettify: boolean | PrettifyType

    Returns Promise<string>

    +
  • Defined in src/export/packer/packer.ts:39
    • @@ -75,7 +77,7 @@
      Optional prettify: boolean | PrettifyType

    Returns Promise<Blob>

    +
  • Defined in src/export/packer/packer.ts:50
    • @@ -90,7 +92,7 @@
      Optional prettify: boolean | PrettifyType

    Returns Promise<Buffer>

    +
  • Defined in src/export/packer/packer.ts:28
    • @@ -105,7 +107,7 @@
      Optional prettify: boolean | PrettifyType

    Returns Stream

    +
  • Defined in src/export/packer/packer.ts:61
    • @@ -120,7 +122,7 @@
      Optional prettify: boolean | PrettifyType

    Returns Promise<string>

    +
  • Defined in src/export/packer/packer.ts:17
  • @@ -20,7 +22,7 @@
    • PageBreak
    +
  • Defined in src/file/paragraph/formatting/break.ts:22
  • @@ -45,7 +47,7 @@

    Returns PageBreak

    +
  • Defined in src/file/paragraph/formatting/break.ts:23
  • Methods

    @@ -61,7 +63,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • PageReference
    +
  • Defined in src/file/paragraph/links/pageref.ts:7
  • @@ -52,7 +54,7 @@

    Returns PageReference

    +
  • Defined in src/file/paragraph/links/pageref.ts:8
  • Methods

    @@ -68,7 +70,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • Paragraph
    +
  • Defined in src/file/paragraph/paragraph.ts:42
  • @@ -51,7 +53,7 @@

    Returns Paragraph

    +
  • Defined in src/file/paragraph/paragraph.ts:45
  • Methods

    @@ -67,7 +69,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
    • @@ -80,7 +82,7 @@
      run: Run

    Returns Paragraph

    +
  • Defined in src/file/paragraph/paragraph.ts:97
  • +
  • Defined in src/file/paragraph/paragraph.ts:79
  • @@ -20,7 +22,7 @@
    • ParagraphProperties
    +
  • Defined in src/file/paragraph/properties.ts:57
  • @@ -51,7 +53,7 @@

    Returns ParagraphProperties

    +
  • Defined in src/file/paragraph/properties.ts:61
  • Methods

    @@ -67,7 +69,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/paragraph/properties.ts:187
  • Returns void

    +
  • Defined in src/file/paragraph/properties.ts:183
  • @@ -20,7 +22,7 @@
    • RunFonts
    +
  • Defined in src/file/paragraph/run/run-fonts.ts:21
  • @@ -52,7 +54,7 @@

    Returns RunFonts

    +
  • Defined in src/file/paragraph/run/run-fonts.ts:22
  • @@ -63,7 +65,7 @@

    Returns RunFonts

  • +
  • Defined in src/file/paragraph/run/run-fonts.ts:23
  • Methods

    @@ -79,7 +81,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • RunPropertiesChange
    +
  • Defined in src/file/paragraph/run/properties.ts:225
  • @@ -50,7 +52,7 @@

    Returns RunPropertiesChange

    +
  • Defined in src/file/paragraph/run/properties.ts:226
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -16,11 +18,11 @@

    Hierarchy

    +
  • Defined in src/file/document/body/section-properties/properties/section-type.ts:24
  • @@ -39,20 +41,20 @@
    +
  • Defined in src/file/xml-components/default-attributes.ts:11
  • Methods

    @@ -68,7 +70,7 @@

    Returns IXmlableObject

    +
  • Defined in src/file/xml-components/default-attributes.ts:16
  • @@ -20,7 +22,7 @@
    • Shading
    +
  • Defined in src/file/shading/shading.ts:37
  • @@ -50,7 +52,7 @@

    Returns Shading

    +
  • Defined in src/file/shading/shading.ts:38
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • SimpleMailMergeField
    +
  • Defined in src/file/paragraph/run/simple-field.ts:19
  • @@ -50,7 +52,7 @@

    Returns SimpleMailMergeField

    +
  • Defined in src/file/paragraph/run/simple-field.ts:20
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • StyleForCharacter
    +
  • Defined in src/file/styles/style/character-style.ts:14
  • @@ -50,7 +52,7 @@

    Returns StyleForCharacter

    +
  • Defined in src/file/styles/style/character-style.ts:17
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • StyleForParagraph
    +
  • Defined in src/file/styles/style/paragraph-style.ts:15
  • @@ -50,7 +52,7 @@

    Returns StyleForParagraph

    +
  • Defined in src/file/styles/style/paragraph-style.ts:19
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • Styles
    +
  • Defined in src/file/styles/styles.ts:22
  • @@ -50,7 +52,7 @@

    Returns Styles

    +
  • Defined in src/file/styles/styles.ts:23
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • SymbolRun
    +
  • Defined in src/file/paragraph/run/symbol-run.ts:9
  • @@ -50,7 +52,7 @@

    Returns SymbolRun

    +
  • Defined in src/file/paragraph/run/symbol-run.ts:10
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • Tab
    +
  • Defined in src/file/paragraph/run/tab.ts:9
  • @@ -45,7 +47,7 @@

    Returns Tab

    +
  • Defined in src/file/paragraph/run/tab.ts:10
  • Methods

    @@ -61,7 +63,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -16,11 +18,11 @@

    Hierarchy

    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:44
  • @@ -39,13 +41,13 @@
    +
  • Defined in src/file/xml-components/default-attributes.ts:11
  • Methods

    @@ -72,7 +74,7 @@

    Returns IXmlableObject

    +
  • Defined in src/file/xml-components/default-attributes.ts:16
  • @@ -20,7 +22,7 @@
    • Table
    +
  • Defined in src/file/table/table.ts:37
  • @@ -50,7 +52,7 @@

    Returns Table

    +
  • Defined in src/file/table/table.ts:38
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • TableBorders
    +
  • Defined in src/file/table/table-properties/table-borders.ts:26
  • @@ -54,17 +56,17 @@

    Returns TableBorders

    +
  • Defined in src/file/table/table-properties/table-borders.ts:36
  • Properties

    -
    NONE: { bottom: { color: string; size: number; style: BorderStyle }; insideHorizontal: { color: string; size: number; style: BorderStyle }; insideVertical: { color: string; size: number; style: BorderStyle }; left: { color: string; size: number; style: BorderStyle }; right: { color: string; size: number; style: BorderStyle }; top: { color: string; size: number; style: BorderStyle } } = ...
    +
    NONE: {
        bottom: {
            color: string;
            size: number;
            style: BorderStyle;
        };
        insideHorizontal: {
            color: string;
            size: number;
            style: BorderStyle;
        };
        insideVertical: {
            color: string;
            size: number;
            style: BorderStyle;
        };
        left: {
            color: string;
            size: number;
            style: BorderStyle;
        };
        right: {
            color: string;
            size: number;
            style: BorderStyle;
        };
        top: {
            color: string;
            size: number;
            style: BorderStyle;
        };
    } = ...

    Type declaration

    • -
      bottom: { color: string; size: number; style: BorderStyle }
      +
      bottom: {
          color: string;
          size: number;
          style: BorderStyle;
      }
    • -
      insideHorizontal: { color: string; size: number; style: BorderStyle }
      +
      insideHorizontal: {
          color: string;
          size: number;
          style: BorderStyle;
      }
    • -
      insideVertical: { color: string; size: number; style: BorderStyle }
      +
      insideVertical: {
          color: string;
          size: number;
          style: BorderStyle;
      }
    • -
      left: { color: string; size: number; style: BorderStyle }
      +
      left: {
          color: string;
          size: number;
          style: BorderStyle;
      }
    • -
      right: { color: string; size: number; style: BorderStyle }
      +
      right: {
          color: string;
          size: number;
          style: BorderStyle;
      }
    • -
      top: { color: string; size: number; style: BorderStyle }
      +
      top: {
          color: string;
          size: number;
          style: BorderStyle;
      }
    +
  • Defined in src/file/table/table-properties/table-borders.ts:27
  • Methods

    @@ -134,7 +136,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • TableRow
    +
  • Defined in src/file/table/table-row/table-row.ts:9
  • @@ -59,7 +61,7 @@

    Returns TableRow

    +
  • Defined in src/file/table/table-row/table-row.ts:10
  • Accessors

    @@ -69,7 +71,7 @@
  • Returns number

  • +
  • Defined in src/file/table/table-row/table-row.ts:19
  • +
  • Defined in src/file/table/table-row/table-row.ts:23
  • Methods

    @@ -94,7 +96,7 @@
    columnIndex: number

    Returns void

    +
  • Defined in src/file/table/table-row/table-row.ts:32
    • @@ -109,7 +111,7 @@
      index: number

    Returns void

    +
  • Defined in src/file/table/table-row/table-row.ts:27
  • +
  • Defined in src/file/xml-components/xml-component.ts:34
    • @@ -138,7 +140,7 @@
      allowEndNewCell: boolean = false

    Returns number

    +
  • Defined in src/file/table/table-row/table-row.ts:51
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
    • @@ -165,7 +167,7 @@
      rootIndex: number

    Returns number

    +
  • Defined in src/file/table/table-row/table-row.ts:37
  • @@ -16,11 +18,11 @@

    Hierarchy

    +
  • Defined in src/file/table/table-row/table-row-height.ts:25
  • @@ -39,13 +41,13 @@
    +
  • Defined in src/file/xml-components/default-attributes.ts:11
  • Methods

    @@ -70,7 +72,7 @@

    Returns IXmlableObject

    +
  • Defined in src/file/xml-components/default-attributes.ts:16
  • @@ -20,7 +22,7 @@
    • TableWidthElement
    +
  • Defined in src/file/table/table-width.ts:37
  • @@ -52,7 +54,7 @@

    Returns TableWidthElement

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

    @@ -68,7 +70,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • TextRun
    +
  • Defined in src/file/paragraph/run/text-run.ts:4
  • @@ -50,7 +52,7 @@

    Returns TextRun

    +
  • Defined in src/file/paragraph/run/text-run.ts:5
  • Methods

    @@ -66,7 +68,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -20,7 +22,7 @@
    • Underline
    +
  • Defined in src/file/paragraph/run/underline.ts:24
  • @@ -52,7 +54,7 @@

    Returns Underline

    +
  • Defined in src/file/paragraph/run/underline.ts:25
  • Methods

    @@ -68,7 +70,7 @@

    Returns XmlComponent

    +
  • Defined in src/file/xml-components/xml-component.ts:34
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • @@ -16,11 +18,11 @@

    Hierarchy

    +
  • Defined in src/file/vertical-align/vertical-align.ts:19
  • @@ -39,20 +41,20 @@
    +
  • Defined in src/file/xml-components/default-attributes.ts:11
  • Methods

    @@ -68,7 +70,7 @@

    Returns IXmlableObject

    +
  • Defined in src/file/xml-components/default-attributes.ts:16
  • @@ -14,7 +16,7 @@
  • BorderStyle
  • Enumeration BorderStyle

    +
  • Defined in src/file/border/border.ts:58
  • @@ -56,137 +58,137 @@
    DASHED: "dashed"
    +
  • Defined in src/file/border/border.ts:61
  • DASH_DOT_STROKED: "dashDotStroked"
    +
  • Defined in src/file/border/border.ts:60
  • DASH_SMALL_GAP: "dashSmallGap"
    +
  • Defined in src/file/border/border.ts:62
  • DOTTED: "dotted"
    +
  • Defined in src/file/border/border.ts:65
  • DOT_DASH: "dotDash"
    +
  • Defined in src/file/border/border.ts:63
  • DOT_DOT_DASH: "dotDotDash"
    +
  • Defined in src/file/border/border.ts:64
  • DOUBLE: "double"
    +
  • Defined in src/file/border/border.ts:66
  • DOUBLE_WAVE: "doubleWave"
    +
  • Defined in src/file/border/border.ts:67
  • INSET: "inset"
    +
  • Defined in src/file/border/border.ts:68
  • NIL: "nil"
    +
  • Defined in src/file/border/border.ts:69
  • NONE: "none"
    +
  • Defined in src/file/border/border.ts:70
  • OUTSET: "outset"
    +
  • Defined in src/file/border/border.ts:71
  • SINGLE: "single"
    +
  • Defined in src/file/border/border.ts:59
  • THICK: "thick"
    +
  • Defined in src/file/border/border.ts:72
  • THICK_THIN_LARGE_GAP: "thickThinLargeGap"
    +
  • Defined in src/file/border/border.ts:73
  • THICK_THIN_MEDIUM_GAP: "thickThinMediumGap"
    +
  • Defined in src/file/border/border.ts:74
  • THICK_THIN_SMALL_GAP: "thickThinSmallGap"
    +
  • Defined in src/file/border/border.ts:75
  • THIN_THICK_LARGE_GAP: "thinThickLargeGap"
    +
  • Defined in src/file/border/border.ts:76
  • THIN_THICK_MEDIUM_GAP: "thinThickMediumGap"
    +
  • Defined in src/file/border/border.ts:77
  • THIN_THICK_SMALL_GAP: "thinThickSmallGap"
    +
  • Defined in src/file/border/border.ts:78
  • THIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap"
    +
  • Defined in src/file/border/border.ts:79
  • THIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap"
    +
  • Defined in src/file/border/border.ts:80
  • THIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap"
    +
  • Defined in src/file/border/border.ts:81
  • THREE_D_EMBOSS: "threeDEmboss"
    +
  • Defined in src/file/border/border.ts:82
  • THREE_D_ENGRAVE: "threeDEngrave"
    +
  • Defined in src/file/border/border.ts:83
  • TRIPLE: "triple"
    +
  • Defined in src/file/border/border.ts:84
  • WAVE: "wave"
    +
  • Defined in src/file/border/border.ts:85
  • @@ -14,7 +16,7 @@
  • EmphasisMarkType
  • Enumeration EmphasisMarkType

    +
  • Defined in src/file/paragraph/run/emphasis-mark.ts:3
  • @@ -30,7 +32,7 @@
    DOT: "dot"
    +
  • Defined in src/file/paragraph/run/emphasis-mark.ts:4
  • @@ -14,7 +16,7 @@
  • HeadingLevel
  • Enumeration HeadingLevel

    +
  • Defined in src/file/paragraph/formatting/style.ts:3
  • @@ -36,37 +38,37 @@
    HEADING_1: "Heading1"
    +
  • Defined in src/file/paragraph/formatting/style.ts:4
  • HEADING_2: "Heading2"
    +
  • Defined in src/file/paragraph/formatting/style.ts:5
  • HEADING_3: "Heading3"
    +
  • Defined in src/file/paragraph/formatting/style.ts:6
  • HEADING_4: "Heading4"
    +
  • Defined in src/file/paragraph/formatting/style.ts:7
  • HEADING_5: "Heading5"
    +
  • Defined in src/file/paragraph/formatting/style.ts:8
  • HEADING_6: "Heading6"
    +
  • Defined in src/file/paragraph/formatting/style.ts:9
  • TITLE: "Title"
    +
  • Defined in src/file/paragraph/formatting/style.ts:10
  • @@ -14,7 +16,7 @@
  • HeightRule
  • Enumeration HeightRule

    +
  • Defined in src/file/table/table-row/table-row-height.ts:16
  • @@ -34,21 +36,21 @@

    At least the value specified

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

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

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

    Exactly the value specified

    +
  • Defined in src/file/table/table-row/table-row-height.ts:22
  • @@ -14,7 +16,7 @@
  • HorizontalPositionAlign
  • Enumeration HorizontalPositionAlign

    +
  • Defined in src/file/shared/alignment.ts:1
  • @@ -34,27 +36,27 @@
    CENTER: "center"
    +
  • Defined in src/file/shared/alignment.ts:2
  • INSIDE: "inside"
    +
  • Defined in src/file/shared/alignment.ts:3
  • LEFT: "left"
    +
  • Defined in src/file/shared/alignment.ts:4
  • OUTSIDE: "outside"
    +
  • Defined in src/file/shared/alignment.ts:5
  • RIGHT: "right"
    +
  • Defined in src/file/shared/alignment.ts:6
  • @@ -14,7 +16,7 @@
  • HyperlinkType
  • Enumeration HyperlinkType

    +
  • Defined in src/file/paragraph/links/hyperlink.ts:8
  • @@ -31,12 +33,12 @@
    EXTERNAL: "EXTERNAL"
    +
  • Defined in src/file/paragraph/links/hyperlink.ts:10
  • INTERNAL: "INTERNAL"
    +
  • Defined in src/file/paragraph/links/hyperlink.ts:9
  • @@ -14,7 +16,7 @@
  • LevelFormat
  • Enumeration LevelFormat

    +
  • Defined in src/file/numbering/level.ts:9
  • @@ -43,72 +45,72 @@
    BULLET: "bullet"
    +
  • Defined in src/file/numbering/level.ts:10
  • CARDINAL_TEXT: "cardinalText"
    +
  • Defined in src/file/numbering/level.ts:11
  • CHICAGO: "chicago"
    +
  • Defined in src/file/numbering/level.ts:12
  • DECIMAL: "decimal"
    +
  • Defined in src/file/numbering/level.ts:13
  • DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle"
    +
  • Defined in src/file/numbering/level.ts:14
  • DECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop"
    +
  • Defined in src/file/numbering/level.ts:15
  • DECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen"
    +
  • Defined in src/file/numbering/level.ts:16
  • DECIMAL_ZERO: "decimalZero"
    +
  • Defined in src/file/numbering/level.ts:17
  • LOWER_LETTER: "lowerLetter"
    +
  • Defined in src/file/numbering/level.ts:18
  • LOWER_ROMAN: "lowerRoman"
    +
  • Defined in src/file/numbering/level.ts:19
  • NONE: "none"
    +
  • Defined in src/file/numbering/level.ts:20
  • ORDINAL_TEXT: "ordinalText"
    +
  • Defined in src/file/numbering/level.ts:21
  • UPPER_LETTER: "upperLetter"
    +
  • Defined in src/file/numbering/level.ts:22
  • UPPER_ROMAN: "upperRoman"
    +
  • Defined in src/file/numbering/level.ts:23
  • @@ -14,7 +16,7 @@
  • LevelSuffix
  • Enumeration LevelSuffix

    +
  • Defined in src/file/numbering/level.ts:77
  • @@ -32,17 +34,17 @@
    NOTHING: "nothing"
    +
  • Defined in src/file/numbering/level.ts:78
  • SPACE: "space"
    +
  • Defined in src/file/numbering/level.ts:79
  • TAB: "tab"
    +
  • Defined in src/file/numbering/level.ts:80
  • @@ -14,7 +16,7 @@
  • LineRuleType
  • Enumeration LineRuleType

    +
  • Defined in src/file/paragraph/formatting/spacing.ts:4
  • @@ -32,17 +34,17 @@
    AT_LEAST: "atLeast"
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:5
  • AUTO: "auto"
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:7
  • EXACTLY: "exactly"
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:6
  • @@ -14,7 +16,7 @@
  • NumberFormat
  • Enumeration NumberFormat

    +
  • Defined in src/file/shared/number-format.ts:69
  • @@ -91,312 +93,312 @@
    AIUEO: "aiueo"
    +
  • Defined in src/file/shared/number-format.ts:82
  • AIUEO_FULL_WIDTH: "aiueoFullWidth"
    +
  • Defined in src/file/shared/number-format.ts:90
  • ARABIC_ABJAD: "arabicAbjad"
    +
  • Defined in src/file/shared/number-format.ts:122
  • ARABIC_ALPHA: "arabicAlpha"
    +
  • Defined in src/file/shared/number-format.ts:121
  • BAHT_TEXT: "bahtText"
    +
  • Defined in src/file/shared/number-format.ts:130
  • BULLET: "bullet"
    +
  • Defined in src/file/shared/number-format.ts:93
  • CARDINAL_TEXT: "cardinalText"
    +
  • Defined in src/file/shared/number-format.ts:76
  • CHICAGO: "chicago"
    +
  • Defined in src/file/shared/number-format.ts:79
  • CHINESE_COUNTING: "chineseCounting"
    +
  • Defined in src/file/shared/number-format.ts:107
  • CHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand"
    +
  • Defined in src/file/shared/number-format.ts:109
  • CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified"
    +
  • Defined in src/file/shared/number-format.ts:108
  • CHOSUNG: "chosung"
    +
  • Defined in src/file/shared/number-format.ts:95
  • DECIMAL: "decimal"
    +
  • Defined in src/file/shared/number-format.ts:70
  • DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle"
    +
  • Defined in src/file/shared/number-format.ts:88
  • DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese"
    +
  • Defined in src/file/shared/number-format.ts:98
  • DECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop"
    +
  • Defined in src/file/shared/number-format.ts:96
  • DECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen"
    +
  • Defined in src/file/shared/number-format.ts:97
  • DECIMAL_FULL_WIDTH: "decimalFullWidth"
    +
  • Defined in src/file/shared/number-format.ts:84
  • DECIMAL_FULL_WIDTH_2: "decimalFullWidth2"
    +
  • Defined in src/file/shared/number-format.ts:89
  • DECIMAL_HALF_WIDTH: "decimalHalfWidth"
    +
  • Defined in src/file/shared/number-format.ts:85
  • DECIMAL_ZERO: "decimalZero"
    +
  • Defined in src/file/shared/number-format.ts:92
  • DOLLAR_TEXT: "dollarText"
    +
  • Defined in src/file/shared/number-format.ts:131
  • GANADA: "ganada"
    +
  • Defined in src/file/shared/number-format.ts:94
  • HEBREW_1: "hebrew1"
    +
  • Defined in src/file/shared/number-format.ts:119
  • HEBREW_2: "hebrew2"
    +
  • Defined in src/file/shared/number-format.ts:120
  • HEX: "hex"
    +
  • Defined in src/file/shared/number-format.ts:78
  • HINDI_CONSONANTS: "hindiConsonants"
    +
  • Defined in src/file/shared/number-format.ts:124
  • HINDI_COUNTING: "hindiCounting"
    +
  • Defined in src/file/shared/number-format.ts:126
  • HINDI_NUMBERS: "hindiNumbers"
    +
  • Defined in src/file/shared/number-format.ts:125
  • HINDI_VOWELS: "hindiVowels"
    +
  • Defined in src/file/shared/number-format.ts:123
  • IDEOGRAPH_DIGITAL: "ideographDigital"
    +
  • Defined in src/file/shared/number-format.ts:80
  • IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle"
    +
  • Defined in src/file/shared/number-format.ts:99
  • IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional"
    +
  • Defined in src/file/shared/number-format.ts:104
  • IDEOGRAPH_TRADITIONAL: "ideographTraditional"
    +
  • Defined in src/file/shared/number-format.ts:100
  • IDEOGRAPH_ZODIAC: "ideographZodiac"
    +
  • Defined in src/file/shared/number-format.ts:101
  • IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional"
    +
  • Defined in src/file/shared/number-format.ts:102
  • IROHA: "iroha"
    +
  • Defined in src/file/shared/number-format.ts:83
  • IROHA_FULL_WIDTH: "irohaFullWidth"
    +
  • Defined in src/file/shared/number-format.ts:91
  • JAPANESE_COUNTING: "japaneseCounting"
    +
  • Defined in src/file/shared/number-format.ts:81
  • JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand"
    +
  • Defined in src/file/shared/number-format.ts:87
  • JAPANESE_LEGAL: "japaneseLegal"
    +
  • Defined in src/file/shared/number-format.ts:86
  • KOREAN_COUNTING: "koreanCounting"
    +
  • Defined in src/file/shared/number-format.ts:111
  • KOREAN_DIGITAL: "koreanDigital"
    +
  • Defined in src/file/shared/number-format.ts:110
  • KOREAN_DIGITAL_2: "koreanDigital2"
    +
  • Defined in src/file/shared/number-format.ts:113
  • KOREAN_LEGAL: "koreanLegal"
    +
  • Defined in src/file/shared/number-format.ts:112
  • LOWER_LETTER: "lowerLetter"
    +
  • Defined in src/file/shared/number-format.ts:74
  • LOWER_ROMAN: "lowerRoman"
    +
  • Defined in src/file/shared/number-format.ts:72
  • NONE: "none"
    +
  • Defined in src/file/shared/number-format.ts:117
  • NUMBER_IN_DASH: "numberInDash"
    +
  • Defined in src/file/shared/number-format.ts:118
  • ORDINAL: "ordinal"
    +
  • Defined in src/file/shared/number-format.ts:75
  • ORDINAL_TEXT: "ordinalText"
    +
  • Defined in src/file/shared/number-format.ts:77
  • RUSSIAN_LOWER: "russianLower"
    +
  • Defined in src/file/shared/number-format.ts:115
  • RUSSIAN_UPPER: "russianUpper"
    +
  • Defined in src/file/shared/number-format.ts:116
  • TAIWANESE_COUNTING: "taiwaneseCounting"
    +
  • Defined in src/file/shared/number-format.ts:103
  • TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand"
    +
  • Defined in src/file/shared/number-format.ts:105
  • TAIWANESE_DIGITAL: "taiwaneseDigital"
    +
  • Defined in src/file/shared/number-format.ts:106
  • THAI_COUNTING: "thaiCounting"
    +
  • Defined in src/file/shared/number-format.ts:129
  • THAI_LETTERS: "thaiLetters"
    +
  • Defined in src/file/shared/number-format.ts:127
  • THAI_NUMBERS: "thaiNumbers"
    +
  • Defined in src/file/shared/number-format.ts:128
  • UPPER_LETTER: "upperLetter"
    +
  • Defined in src/file/shared/number-format.ts:73
  • UPPER_ROMAN: "upperRoman"
    +
  • Defined in src/file/shared/number-format.ts:71
  • VIETNAMESE_COUNTING: "vietnameseCounting"
    +
  • Defined in src/file/shared/number-format.ts:114
  • @@ -14,7 +16,7 @@
  • PageNumber
  • Enumeration PageNumber

    +
  • Defined in src/file/paragraph/run/run.ts:19
  • @@ -32,17 +34,17 @@
    CURRENT: "CURRENT"
    +
  • Defined in src/file/paragraph/run/run.ts:20
  • TOTAL_PAGES: "TOTAL_PAGES"
    +
  • Defined in src/file/paragraph/run/run.ts:21
  • TOTAL_PAGES_IN_SECTION: "TOTAL_PAGES_IN_SECTION"
    +
  • Defined in src/file/paragraph/run/run.ts:22
  • @@ -17,7 +19,7 @@

    Use blanks to prettify

    +
  • Defined in src/export/packer/packer.ts:9
  • @@ -36,22 +38,22 @@
    NONE: ""
    +
  • Defined in src/export/packer/packer.ts:10
  • WITH_2_BLANKS: " "
    +
  • Defined in src/export/packer/packer.ts:11
  • WITH_4_BLANKS: " "
    +
  • Defined in src/export/packer/packer.ts:12
  • WITH_TAB: "\t"
    +
  • Defined in src/export/packer/packer.ts:13
  • @@ -14,7 +16,7 @@
  • ShadingType
  • Enumeration ShadingType

    +
  • Defined in src/file/shading/shading.ts:50
  • @@ -66,187 +68,187 @@
    CLEAR: "clear"
    +
  • Defined in src/file/shading/shading.ts:51
  • DIAGONAL_CROSS: "diagCross"
    +
  • Defined in src/file/shading/shading.ts:52
  • DIAGONAL_STRIPE: "diagStripe"
    +
  • Defined in src/file/shading/shading.ts:53
  • HORIZONTAL_CROSS: "horzCross"
    +
  • Defined in src/file/shading/shading.ts:54
  • HORIZONTAL_STRIPE: "horzStripe"
    +
  • Defined in src/file/shading/shading.ts:55
  • NIL: "nil"
    +
  • Defined in src/file/shading/shading.ts:56
  • PERCENT_10: "pct10"
    +
  • Defined in src/file/shading/shading.ts:58
  • PERCENT_12: "pct12"
    +
  • Defined in src/file/shading/shading.ts:59
  • PERCENT_15: "pct15"
    +
  • Defined in src/file/shading/shading.ts:60
  • PERCENT_20: "pct20"
    +
  • Defined in src/file/shading/shading.ts:61
  • PERCENT_25: "pct25"
    +
  • Defined in src/file/shading/shading.ts:62
  • PERCENT_30: "pct30"
    +
  • Defined in src/file/shading/shading.ts:63
  • PERCENT_35: "pct35"
    +
  • Defined in src/file/shading/shading.ts:64
  • PERCENT_37: "pct37"
    +
  • Defined in src/file/shading/shading.ts:65
  • PERCENT_40: "pct40"
    +
  • Defined in src/file/shading/shading.ts:66
  • PERCENT_45: "pct45"
    +
  • Defined in src/file/shading/shading.ts:67
  • PERCENT_5: "pct5"
    +
  • Defined in src/file/shading/shading.ts:57
  • PERCENT_50: "pct50"
    +
  • Defined in src/file/shading/shading.ts:68
  • PERCENT_55: "pct55"
    +
  • Defined in src/file/shading/shading.ts:69
  • PERCENT_60: "pct60"
    +
  • Defined in src/file/shading/shading.ts:70
  • PERCENT_62: "pct62"
    +
  • Defined in src/file/shading/shading.ts:71
  • PERCENT_65: "pct65"
    +
  • Defined in src/file/shading/shading.ts:72
  • PERCENT_70: "pct70"
    +
  • Defined in src/file/shading/shading.ts:73
  • PERCENT_75: "pct75"
    +
  • Defined in src/file/shading/shading.ts:74
  • PERCENT_80: "pct80"
    +
  • Defined in src/file/shading/shading.ts:75
  • PERCENT_85: "pct85"
    +
  • Defined in src/file/shading/shading.ts:76
  • PERCENT_87: "pct87"
    +
  • Defined in src/file/shading/shading.ts:77
  • PERCENT_90: "pct90"
    +
  • Defined in src/file/shading/shading.ts:78
  • PERCENT_95: "pct95"
    +
  • Defined in src/file/shading/shading.ts:79
  • REVERSE_DIAGONAL_STRIPE: "reverseDiagStripe"
    +
  • Defined in src/file/shading/shading.ts:80
  • SOLID: "solid"
    +
  • Defined in src/file/shading/shading.ts:81
  • THIN_DIAGONAL_CROSS: "thinDiagCross"
    +
  • Defined in src/file/shading/shading.ts:82
  • THIN_DIAGONAL_STRIPE: "thinDiagStripe"
    +
  • Defined in src/file/shading/shading.ts:83
  • THIN_HORIZONTAL_CROSS: "thinHorzCross"
    +
  • Defined in src/file/shading/shading.ts:84
  • THIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe"
    +
  • Defined in src/file/shading/shading.ts:85
  • THIN_VERTICAL_STRIPE: "thinVertStripe"
    +
  • Defined in src/file/shading/shading.ts:86
  • VERTICAL_STRIPE: "vertStripe"
    +
  • Defined in src/file/shading/shading.ts:87
  • @@ -14,7 +16,7 @@
  • SpaceType
  • Enumeration SpaceType

    +
  • Defined in src/file/space-type.ts:1
  • @@ -31,12 +33,12 @@
    DEFAULT: "default"
    +
  • Defined in src/file/space-type.ts:2
  • PRESERVE: "preserve"
    +
  • Defined in src/file/space-type.ts:3
  • @@ -14,7 +16,7 @@
  • TabStopPosition
  • Enumeration TabStopPosition

    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:40
  • @@ -30,7 +32,7 @@
    MAX: 9026
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:41
  • @@ -14,7 +16,7 @@
  • TextDirection
  • Enumeration TextDirection

    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:113
  • @@ -32,17 +34,17 @@
    BOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr"
    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:114
  • LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb"
    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:115
  • TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl"
    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:116
  • @@ -14,7 +16,7 @@
  • UnderlineType
  • Enumeration UnderlineType

    +
  • Defined in src/file/paragraph/run/underline.ts:4
  • @@ -46,87 +48,87 @@
    DASH: "dash"
    +
  • Defined in src/file/paragraph/run/underline.ts:11
  • DASHDOTDOTHEAVY: "dashDotDotHeavy"
    +
  • Defined in src/file/paragraph/run/underline.ts:18
  • DASHDOTHEAVY: "dashDotHeavy"
    +
  • Defined in src/file/paragraph/run/underline.ts:16
  • DASHEDHEAVY: "dashedHeavy"
    +
  • Defined in src/file/paragraph/run/underline.ts:12
  • DASHLONG: "dashLong"
    +
  • Defined in src/file/paragraph/run/underline.ts:13
  • DASHLONGHEAVY: "dashLongHeavy"
    +
  • Defined in src/file/paragraph/run/underline.ts:14
  • DOTDASH: "dotDash"
    +
  • Defined in src/file/paragraph/run/underline.ts:15
  • DOTDOTDASH: "dotDotDash"
    +
  • Defined in src/file/paragraph/run/underline.ts:17
  • DOTTED: "dotted"
    +
  • Defined in src/file/paragraph/run/underline.ts:9
  • DOTTEDHEAVY: "dottedHeavy"
    +
  • Defined in src/file/paragraph/run/underline.ts:10
  • DOUBLE: "double"
    +
  • Defined in src/file/paragraph/run/underline.ts:7
  • SINGLE: "single"
    +
  • Defined in src/file/paragraph/run/underline.ts:5
  • THICK: "thick"
    +
  • Defined in src/file/paragraph/run/underline.ts:8
  • WAVE: "wave"
    +
  • Defined in src/file/paragraph/run/underline.ts:19
  • WAVYDOUBLE: "wavyDouble"
    +
  • Defined in src/file/paragraph/run/underline.ts:21
  • WAVYHEAVY: "wavyHeavy"
    +
  • Defined in src/file/paragraph/run/underline.ts:20
  • WORDS: "words"
    +
  • Defined in src/file/paragraph/run/underline.ts:6
  • @@ -17,7 +19,7 @@

    Vertical merge types.

    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:83
  • @@ -36,14 +38,14 @@

    Cell that is merged with upper one.

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

    Cell that is starting the vertical merge.

    +
  • Defined in src/file/table/table-cell/table-cell-components.ts:91
  • @@ -14,7 +16,7 @@
  • VerticalPositionAlign
  • Enumeration VerticalPositionAlign

    +
  • Defined in src/file/shared/alignment.ts:9
  • @@ -34,27 +36,27 @@
    BOTTOM: "bottom"
    +
  • Defined in src/file/shared/alignment.ts:10
  • CENTER: "center"
    +
  • Defined in src/file/shared/alignment.ts:11
  • INSIDE: "inside"
    +
  • Defined in src/file/shared/alignment.ts:12
  • OUTSIDE: "outside"
    +
  • Defined in src/file/shared/alignment.ts:13
  • TOP: "top"
    +
  • Defined in src/file/shared/alignment.ts:14
  • @@ -14,7 +16,7 @@
  • WidthType
  • Enumeration WidthType

    +
  • Defined in src/file/table/table-width.ts:13
  • @@ -35,28 +37,28 @@

    Auto.

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

    Value is in twentieths of a point

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

    No (empty) value.

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

    Value is in percentage.

    +
  • Defined in src/file/table/table-width.ts:21
  • @@ -24,7 +26,7 @@
    inches: number

    Returns number

    +
  • Defined in src/util/convenience-functions.ts:8
  • @@ -24,7 +26,7 @@
    millimeters: number

    Returns number

    +
  • Defined in src/util/convenience-functions.ts:6
  • @@ -28,7 +30,7 @@

    Returns undefined | string | ImportedXmlComponent

    +
  • Defined in src/file/xml-components/imported-xml-component.ts:13
  • @@ -24,7 +26,7 @@
    val: Date

    Returns string

    +
  • Defined in src/util/values.ts:215
  • @@ -24,7 +26,7 @@
    val: number

    Returns number

    +
  • Defined in src/util/values.ts:10
  • @@ -24,7 +26,7 @@
    val: number

    Returns number

    +
  • Defined in src/util/values.ts:20
  • @@ -24,7 +26,7 @@
    val: string

    Returns string

    +
  • Defined in src/util/values.ts:113
  • @@ -24,7 +26,7 @@
    val: string | number

    Returns string | number

    +
  • Defined in src/util/values.ts:132
  • @@ -24,7 +26,7 @@
    val: string

    Returns string

    +
  • Defined in src/util/values.ts:46
  • @@ -24,7 +26,7 @@
    val: string | number

    Returns string | number

    +
  • Defined in src/util/values.ts:175
  • @@ -24,7 +26,7 @@
    val: string

    Returns string

    +
  • Defined in src/util/values.ts:152
  • @@ -24,7 +26,7 @@
    val: number

    Returns number

    +
  • Defined in src/util/values.ts:20
  • @@ -24,7 +26,7 @@
    val: string

    Returns string

    +
  • Defined in src/util/values.ts:91
  • @@ -24,7 +26,7 @@
    val: string

    Returns string

    +
  • Defined in src/util/values.ts:53
  • @@ -24,7 +26,7 @@
    val: string | number

    Returns string | number

    +
  • Defined in src/util/values.ts:138
  • @@ -24,7 +26,7 @@
    val: string | number

    Returns string | number

    +
  • Defined in src/util/values.ts:126
  • @@ -24,7 +26,7 @@
    val: string | number

    Returns string | number

    +
  • Defined in src/util/values.ts:144
  • @@ -24,7 +26,7 @@
    val: string

    Returns string

    +
  • Defined in src/util/values.ts:60
  • @@ -19,7 +21,7 @@
  • Returns string

  • +
  • Defined in src/util/convenience-functions.ts:12
  • @@ -19,7 +21,7 @@
  • Returns number

  • +
  • Defined in src/util/convenience-functions.ts:10
  • @@ -24,7 +26,7 @@
    val: string

    Returns string

    +
  • Defined in src/util/values.ts:73
  • @@ -24,7 +26,7 @@
    val: number

    Returns number

    +
  • Defined in src/util/values.ts:20
  • diff --git a/api/interfaces/IAlignmentFrameOptions.html b/api/interfaces/IAlignmentFrameOptions.html index 78c4ffc319..d80cb2e083 100644 --- a/api/interfaces/IAlignmentFrameOptions.html +++ b/api/interfaces/IAlignmentFrameOptions.html @@ -1,11 +1,13 @@ IAlignmentFrameOptions | docx
    -
    +
  • The search index is not available
  • docx
    +
    @@ -20,7 +22,7 @@
    • IAlignmentFrameOptions
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:52
  • @@ -43,7 +45,7 @@

    Properties

    - +
    alignment: {
        x: HorizontalPositionAlign;
        y: VerticalPositionAlign;
    }

    Type declaration

    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:53
  • -
    anchor: { horizontal: FrameAnchorType; vertical: FrameAnchorType }
    +
    anchor: {
        horizontal: FrameAnchorType;
        vertical: FrameAnchorType;
    }

    Type declaration

    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:34
  • anchorLock?: boolean
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:28
  • dropCap?: DropCapType
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:29
  • height: number
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:31
  • lines?: number
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:33
  • rule?: HeightRule
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:42
  • -
    space?: { horizontal: number; vertical: number }
    +
    space?: {
        horizontal: number;
        vertical: number;
    }

    Type declaration

      @@ -108,19 +110,19 @@
      Readonly vertical: number
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:38
  • width: number
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:30
  • wrap?: FrameWrap
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:32
  • @@ -22,7 +24,7 @@ +
  • Defined in src/file/styles/style/character-style.ts:5
  • @@ -47,54 +49,54 @@
    basedOn?: string
    +
  • Defined in src/file/styles/style/style.ts:44
  • link?: string
    +
  • Defined in src/file/styles/style/style.ts:46
  • name?: string
    +
  • Defined in src/file/styles/style/style.ts:43
  • next?: string
    +
  • Defined in src/file/styles/style/style.ts:45
  • quickFormat?: boolean
    +
  • Defined in src/file/styles/style/style.ts:50
  • +
  • Defined in src/file/styles/style/character-style.ts:6
  • semiHidden?: boolean
    +
  • Defined in src/file/styles/style/style.ts:48
  • uiPriority?: number
    +
  • Defined in src/file/styles/style/style.ts:47
  • unhideWhenUsed?: boolean
    +
  • Defined in src/file/styles/style/style.ts:49
  • @@ -22,7 +24,7 @@ +
  • Defined in src/file/styles/style/paragraph-style.ts:5
  • @@ -48,59 +50,59 @@
    basedOn?: string
    +
  • Defined in src/file/styles/style/style.ts:44
  • link?: string
    +
  • Defined in src/file/styles/style/style.ts:46
  • name?: string
    +
  • Defined in src/file/styles/style/style.ts:43
  • next?: string
    +
  • Defined in src/file/styles/style/style.ts:45
  • +
  • Defined in src/file/styles/style/paragraph-style.ts:6
  • quickFormat?: boolean
    +
  • Defined in src/file/styles/style/style.ts:50
  • +
  • Defined in src/file/styles/style/paragraph-style.ts:7
  • semiHidden?: boolean
    +
  • Defined in src/file/styles/style/style.ts:48
  • uiPriority?: number
    +
  • Defined in src/file/styles/style/style.ts:47
  • unhideWhenUsed?: boolean
    +
  • Defined in src/file/styles/style/style.ts:49
  • @@ -18,7 +20,7 @@
    • IBorderOptions
    +
  • Defined in src/file/border/border.ts:25
  • @@ -39,26 +41,26 @@

    Border color, in hex (eg 'FF00AA')

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

    Size of the border in 1/8 pt

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

    Spacing offset. Values are specified in pt

    +
  • Defined in src/file/border/border.ts:32
  • +
  • Defined in src/file/border/border.ts:26
  • @@ -18,7 +20,7 @@
    • IBordersOptions
    +
  • Defined in src/file/paragraph/formatting/border.ts:5
  • @@ -37,22 +39,22 @@
    +
  • Defined in src/file/paragraph/formatting/border.ts:7
  • +
  • Defined in src/file/paragraph/formatting/border.ts:8
  • +
  • Defined in src/file/paragraph/formatting/border.ts:9
  • +
  • Defined in src/file/paragraph/formatting/border.ts:6
  • @@ -20,7 +22,7 @@
    • ICharacterStyleOptions
    +
  • Defined in src/file/styles/style/character-style.ts:9
  • @@ -46,60 +48,60 @@
    basedOn?: string
    +
  • Defined in src/file/styles/style/style.ts:44
  • id: string
    +
  • Defined in src/file/styles/style/character-style.ts:10
  • link?: string
    +
  • Defined in src/file/styles/style/style.ts:46
  • name?: string
    +
  • Defined in src/file/styles/style/character-style.ts:11
  • next?: string
    +
  • Defined in src/file/styles/style/style.ts:45
  • quickFormat?: boolean
    +
  • Defined in src/file/styles/style/style.ts:50
  • +
  • Defined in src/file/styles/style/character-style.ts:6
  • semiHidden?: boolean
    +
  • Defined in src/file/styles/style/style.ts:48
  • uiPriority?: number
    +
  • Defined in src/file/styles/style/style.ts:47
  • unhideWhenUsed?: boolean
    +
  • Defined in src/file/styles/style/style.ts:49
  • @@ -18,7 +20,7 @@
    • ICommentOptions
    +
  • Defined in src/file/paragraph/run/comment-run.ts:6
  • @@ -38,27 +40,27 @@
    author?: string
    +
  • Defined in src/file/paragraph/run/comment-run.ts:10
  • date?: Date
    +
  • Defined in src/file/paragraph/run/comment-run.ts:11
  • id: number
    +
  • Defined in src/file/paragraph/run/comment-run.ts:7
  • initials?: string
    +
  • Defined in src/file/paragraph/run/comment-run.ts:9
  • text: string
    +
  • Defined in src/file/paragraph/run/comment-run.ts:8
  • @@ -18,7 +20,7 @@
    • ICommentsOptions
    +
  • Defined in src/file/paragraph/run/comment-run.ts:14
  • @@ -34,7 +36,7 @@
    children: readonly ICommentOptions[]
    +
  • Defined in src/file/paragraph/run/comment-run.ts:15
  • @@ -18,7 +20,7 @@
    • IConcreteNumberingOptions
    +
  • Defined in src/file/numbering/num.ts:21
  • @@ -38,20 +40,20 @@
    abstractNumId: number
    +
  • Defined in src/file/numbering/num.ts:23
  • instance: number
    +
  • Defined in src/file/numbering/num.ts:25
  • numId: number
    +
  • Defined in src/file/numbering/num.ts:22
  • -
    overrideLevel?: { num: number; start?: number }
    +
    overrideLevel?: {
        num: number;
        start?: number;
    }

    Type declaration

      @@ -60,12 +62,12 @@
    • Optional Readonly start?: number
    +
  • Defined in src/file/numbering/num.ts:26
  • reference: string
    +
  • Defined in src/file/numbering/num.ts:24
  • @@ -18,7 +20,7 @@
    • IContext
    +
  • Defined in src/file/xml-components/base.ts:5
  • @@ -35,12 +37,12 @@
    file: Document
    +
  • Defined in src/file/xml-components/base.ts:6
  • viewWrapper: IViewWrapper
    +
  • Defined in src/file/xml-components/base.ts:7
  • @@ -18,7 +20,7 @@
    • IDistance
    +
  • Defined in src/file/drawing/drawing.ts:7
  • @@ -37,22 +39,22 @@
    distB?: number
    +
  • Defined in src/file/drawing/drawing.ts:9
  • distL?: number
    +
  • Defined in src/file/drawing/drawing.ts:10
  • distR?: number
    +
  • Defined in src/file/drawing/drawing.ts:11
  • distT?: number
    +
  • Defined in src/file/drawing/drawing.ts:8
  • @@ -18,7 +20,7 @@
    • IDocumentAttributesProperties
    +
  • Defined in src/file/document/document-attributes.ts:4
  • @@ -72,197 +74,197 @@
    Ignorable?: string
    +
  • Defined in src/file/document/document-attributes.ts:21
  • aink?: string
    +
  • Defined in src/file/document/document-attributes.ts:37
  • am3d?: string
    +
  • Defined in src/file/document/document-attributes.ts:38
  • cp?: string
    +
  • Defined in src/file/document/document-attributes.ts:22
  • cx?: string
    +
  • Defined in src/file/document/document-attributes.ts:28
  • cx1?: string
    +
  • Defined in src/file/document/document-attributes.ts:29
  • cx2?: string
    +
  • Defined in src/file/document/document-attributes.ts:30
  • cx3?: string
    +
  • Defined in src/file/document/document-attributes.ts:31
  • cx4?: string
    +
  • Defined in src/file/document/document-attributes.ts:32
  • cx5?: string
    +
  • Defined in src/file/document/document-attributes.ts:33
  • cx6?: string
    +
  • Defined in src/file/document/document-attributes.ts:34
  • cx7?: string
    +
  • Defined in src/file/document/document-attributes.ts:35
  • cx8?: string
    +
  • Defined in src/file/document/document-attributes.ts:36
  • dc?: string
    +
  • Defined in src/file/document/document-attributes.ts:23
  • dcmitype?: string
    +
  • Defined in src/file/document/document-attributes.ts:25
  • dcterms?: string
    +
  • Defined in src/file/document/document-attributes.ts:24
  • m?: string
    +
  • Defined in src/file/document/document-attributes.ts:9
  • mc?: string
    +
  • Defined in src/file/document/document-attributes.ts:6
  • o?: string
    +
  • Defined in src/file/document/document-attributes.ts:7
  • r?: string
    +
  • Defined in src/file/document/document-attributes.ts:8
  • type?: string
    +
  • Defined in src/file/document/document-attributes.ts:27
  • v?: string
    +
  • Defined in src/file/document/document-attributes.ts:10
  • w?: string
    +
  • Defined in src/file/document/document-attributes.ts:14
  • w10?: string
    +
  • Defined in src/file/document/document-attributes.ts:13
  • w14?: string
    +
  • Defined in src/file/document/document-attributes.ts:15
  • w15?: string
    +
  • Defined in src/file/document/document-attributes.ts:16
  • w16?: string
    +
  • Defined in src/file/document/document-attributes.ts:41
  • w16cex?: string
    +
  • Defined in src/file/document/document-attributes.ts:39
  • w16cid?: string
    +
  • Defined in src/file/document/document-attributes.ts:40
  • w16sdtdh?: string
    +
  • Defined in src/file/document/document-attributes.ts:42
  • w16se?: string
    +
  • Defined in src/file/document/document-attributes.ts:43
  • wne?: string
    +
  • Defined in src/file/document/document-attributes.ts:19
  • wp?: string
    +
  • Defined in src/file/document/document-attributes.ts:12
  • wp14?: string
    +
  • Defined in src/file/document/document-attributes.ts:11
  • wpc?: string
    +
  • Defined in src/file/document/document-attributes.ts:5
  • wpg?: string
    +
  • Defined in src/file/document/document-attributes.ts:17
  • wpi?: string
    +
  • Defined in src/file/document/document-attributes.ts:18
  • wps?: string
    +
  • Defined in src/file/document/document-attributes.ts:20
  • xsi?: string
    +
  • Defined in src/file/document/document-attributes.ts:26
  • @@ -18,7 +20,7 @@
    • IDocumentFooter
    +
  • Defined in src/file/footer-wrapper.ts:11
  • @@ -35,12 +37,12 @@
    +
  • Defined in src/file/footer-wrapper.ts:12
  • +
  • Defined in src/file/footer-wrapper.ts:13
  • @@ -18,7 +20,7 @@
    • IDocumentHeader
    +
  • Defined in src/file/header-wrapper.ts:11
  • @@ -35,12 +37,12 @@
    +
  • Defined in src/file/header-wrapper.ts:12
  • +
  • Defined in src/file/header-wrapper.ts:13
  • @@ -18,7 +20,7 @@
    • IDocumentOptions
    +
  • Defined in src/file/document/document.ts:10
  • @@ -34,7 +36,7 @@
    +
  • Defined in src/file/document/document.ts:11
  • @@ -18,7 +20,7 @@
    • IDocumentTemplate
    +
  • Defined in src/import-dotx/import-dotx.ts:40
  • @@ -39,32 +41,32 @@
    currentRelationshipId: number
    +
  • Defined in src/import-dotx/import-dotx.ts:41
  • footers: IDocumentFooter[]
    +
  • Defined in src/import-dotx/import-dotx.ts:43
  • headers: IDocumentHeader[]
    +
  • Defined in src/import-dotx/import-dotx.ts:42
  • media: Media
    +
  • Defined in src/import-dotx/import-dotx.ts:46
  • styles: string
    +
  • Defined in src/import-dotx/import-dotx.ts:44
  • titlePageIsDefined: boolean
    +
  • Defined in src/import-dotx/import-dotx.ts:45
  • @@ -18,7 +20,7 @@
    • IDrawingOptions
    +
  • Defined in src/file/drawing/drawing.ts:14
  • @@ -34,7 +36,7 @@
    floating?: IFloating
    +
  • Defined in src/file/drawing/drawing.ts:15
  • @@ -18,7 +20,7 @@
    • IFileProperties
    +
  • Defined in src/file/file-properties.ts:3
  • @@ -34,7 +36,7 @@
    +
  • Defined in src/file/file-properties.ts:4
  • @@ -18,7 +20,7 @@
    • IFloating
    +
  • Defined in src/file/drawing/floating/floating-position.ts:48
  • @@ -42,47 +44,47 @@
    allowOverlap?: boolean
    +
  • Defined in src/file/drawing/floating/floating-position.ts:51
  • behindDocument?: boolean
    +
  • Defined in src/file/drawing/floating/floating-position.ts:53
  • horizontalPosition: IHorizontalPositionOptions
    +
  • Defined in src/file/drawing/floating/floating-position.ts:49
  • layoutInCell?: boolean
    +
  • Defined in src/file/drawing/floating/floating-position.ts:54
  • lockAnchor?: boolean
    +
  • Defined in src/file/drawing/floating/floating-position.ts:52
  • margins?: IMargins
    +
  • Defined in src/file/drawing/floating/floating-position.ts:55
  • verticalPosition: IVerticalPositionOptions
    +
  • Defined in src/file/drawing/floating/floating-position.ts:50
  • +
  • Defined in src/file/drawing/floating/floating-position.ts:56
  • zIndex?: number
    +
  • Defined in src/file/drawing/floating/floating-position.ts:57
  • @@ -18,7 +20,7 @@
    • IFontAttributesProperties
    +
  • Defined in src/file/paragraph/run/run-fonts.ts:3
  • @@ -38,27 +40,27 @@
    ascii?: string
    +
  • Defined in src/file/paragraph/run/run-fonts.ts:4
  • cs?: string
    +
  • Defined in src/file/paragraph/run/run-fonts.ts:5
  • eastAsia?: string
    +
  • Defined in src/file/paragraph/run/run-fonts.ts:6
  • hAnsi?: string
    +
  • Defined in src/file/paragraph/run/run-fonts.ts:7
  • hint?: string
    +
  • Defined in src/file/paragraph/run/run-fonts.ts:8
  • @@ -18,7 +20,7 @@
    • IHeaderOptions
    +
  • Defined in src/file/header.ts:4
  • @@ -34,7 +36,7 @@
    children: readonly (Paragraph | Table)[]
    +
  • Defined in src/file/header.ts:5
  • @@ -18,7 +20,7 @@
    • IImageOptions
    +
  • Defined in src/file/paragraph/run/image-run.ts:10
  • @@ -36,17 +38,17 @@
    data: string | ArrayBuffer | Uint8Array | Buffer
    +
  • Defined in src/file/paragraph/run/image-run.ts:11
  • floating?: IFloating
    +
  • Defined in src/file/paragraph/run/image-run.ts:13
  • transformation: IMediaTransformation
    +
  • Defined in src/file/paragraph/run/image-run.ts:12
  • @@ -18,7 +20,7 @@
    • IIndentAttributesProperties
    +
  • Defined in src/file/paragraph/formatting/indent.ts:5
  • @@ -39,32 +41,32 @@
    end?: string | number
    +
  • Defined in src/file/paragraph/formatting/indent.ts:7
  • firstLine?: string | number
    +
  • Defined in src/file/paragraph/formatting/indent.ts:11
  • hanging?: string | number
    +
  • Defined in src/file/paragraph/formatting/indent.ts:10
  • left?: string | number
    +
  • Defined in src/file/paragraph/formatting/indent.ts:8
  • right?: string | number
    +
  • Defined in src/file/paragraph/formatting/indent.ts:9
  • start?: string | number
    +
  • Defined in src/file/paragraph/formatting/indent.ts:6
  • @@ -20,7 +22,7 @@ +
  • Defined in src/file/paragraph/properties.ts:18
  • @@ -45,52 +47,52 @@
    alignment?: AlignmentType
    +
  • Defined in src/file/paragraph/properties.ts:19
  • contextualSpacing?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:21
  • +
  • Defined in src/file/paragraph/properties.ts:24
  • keepLines?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:27
  • keepNext?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:26
  • leftTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:23
  • outlineLevel?: number
    +
  • Defined in src/file/paragraph/properties.ts:28
  • rightTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:22
  • +
  • Defined in src/file/paragraph/properties.ts:25
  • thematicBreak?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:20
  • @@ -18,7 +20,7 @@
    • ILevelsOptions
    +
  • Defined in src/file/numbering/level.ts:83
  • @@ -41,30 +43,30 @@
    alignment?: AlignmentType
    +
  • Defined in src/file/numbering/level.ts:87
  • format?: LevelFormat
    +
  • Defined in src/file/numbering/level.ts:85
  • isLegalNumberingStyle?: boolean
    +
  • Defined in src/file/numbering/level.ts:90
  • level: number
    +
  • Defined in src/file/numbering/level.ts:84
  • start?: number
    +
  • Defined in src/file/numbering/level.ts:88
  • - +
    style?: {
        paragraph?: ILevelParagraphStylePropertiesOptions;
        run?: IRunStylePropertiesOptions;
    }

    Type declaration

    +
  • Defined in src/file/numbering/level.ts:91
  • suffix?: LevelSuffix
    +
  • Defined in src/file/numbering/level.ts:89
  • text?: string
    +
  • Defined in src/file/numbering/level.ts:86
  • @@ -18,7 +20,7 @@
    • IMargins
    +
  • Defined in src/file/drawing/floating/floating-position.ts:41
  • @@ -37,22 +39,22 @@
    bottom?: number
    +
  • Defined in src/file/drawing/floating/floating-position.ts:43
  • left?: number
    +
  • Defined in src/file/drawing/floating/floating-position.ts:42
  • right?: number
    +
  • Defined in src/file/drawing/floating/floating-position.ts:45
  • top?: number
    +
  • Defined in src/file/drawing/floating/floating-position.ts:44
  • @@ -18,7 +20,7 @@
    • IMathFractionOptions
    +
  • Defined in src/file/paragraph/math/fraction/math-fraction.ts:7
  • @@ -35,12 +37,12 @@
    denominator: readonly MathComponent[]
    +
  • Defined in src/file/paragraph/math/fraction/math-fraction.ts:9
  • numerator: readonly MathComponent[]
    +
  • Defined in src/file/paragraph/math/fraction/math-fraction.ts:8
  • @@ -18,7 +20,7 @@
    • IMathIntegralOptions
    +
  • Defined in src/file/paragraph/math/n-ary/math-integral.ts:9
  • @@ -36,17 +38,17 @@
    children: readonly MathComponent[]
    +
  • Defined in src/file/paragraph/math/n-ary/math-integral.ts:10
  • subScript?: readonly MathComponent[]
    +
  • Defined in src/file/paragraph/math/n-ary/math-integral.ts:11
  • superScript?: readonly MathComponent[]
    +
  • Defined in src/file/paragraph/math/n-ary/math-integral.ts:12
  • @@ -18,7 +20,7 @@
    • IMathOptions
    +
  • Defined in src/file/paragraph/math/math.ts:6
  • @@ -34,7 +36,7 @@
    children: readonly MathComponent[]
    +
  • Defined in src/file/paragraph/math/math.ts:7
  • @@ -18,7 +20,7 @@
    • IMathRadicalOptions
    +
  • Defined in src/file/paragraph/math/radical/math-radical.ts:9
  • @@ -35,12 +37,12 @@
    children: readonly MathComponent[]
    +
  • Defined in src/file/paragraph/math/radical/math-radical.ts:10
  • degree?: readonly MathComponent[]
    +
  • Defined in src/file/paragraph/math/radical/math-radical.ts:11
  • @@ -18,7 +20,7 @@
    • IMathSumOptions
    +
  • Defined in src/file/paragraph/math/n-ary/math-sum.ts:10
  • @@ -36,17 +38,17 @@
    children: readonly MathComponent[]
    +
  • Defined in src/file/paragraph/math/n-ary/math-sum.ts:11
  • subScript?: readonly MathComponent[]
    +
  • Defined in src/file/paragraph/math/n-ary/math-sum.ts:12
  • superScript?: readonly MathComponent[]
    +
  • Defined in src/file/paragraph/math/n-ary/math-sum.ts:13
  • @@ -18,7 +20,7 @@
    • IMediaData
    +
  • Defined in src/file/media/data.ts:17
  • @@ -36,17 +38,17 @@
    fileName: string
    +
  • Defined in src/file/media/data.ts:19
  • stream: ArrayBuffer | Uint8Array | Buffer
    +
  • Defined in src/file/media/data.ts:18
  • transformation: IMediaDataTransformation
    +
  • Defined in src/file/media/data.ts:20
  • @@ -18,7 +20,7 @@
    • IMediaDataTransformation
    +
  • Defined in src/file/media/data.ts:1
  • @@ -35,7 +37,7 @@

    Properties

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

    Type declaration

      @@ -44,10 +46,10 @@
    • Readonly y: number
    +
  • Defined in src/file/media/data.ts:6
  • -
    flip?: { horizontal?: boolean; vertical?: boolean }
    +
    flip?: {
        horizontal?: boolean;
        vertical?: boolean;
    }

    Type declaration

      @@ -56,10 +58,10 @@
    • Optional Readonly vertical?: boolean
    +
  • Defined in src/file/media/data.ts:10
  • -
    pixels: { x: number; y: number }
    +
    pixels: {
        x: number;
        y: number;
    }

    Type declaration

      @@ -68,12 +70,12 @@
    • Readonly y: number
    +
  • Defined in src/file/media/data.ts:2
  • rotation?: number
    +
  • Defined in src/file/media/data.ts:14
  • @@ -18,7 +20,7 @@
    • IMediaTransformation
    +
  • Defined in src/file/media/media.ts:5
  • @@ -35,7 +37,7 @@

    Properties

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

    Type declaration

      @@ -44,22 +46,22 @@
    • Optional Readonly vertical?: boolean
    +
  • Defined in src/file/media/media.ts:8
  • height: number
    +
  • Defined in src/file/media/media.ts:7
  • rotation?: number
    +
  • Defined in src/file/media/media.ts:12
  • width: number
    +
  • Defined in src/file/media/media.ts:6
  • @@ -18,7 +20,7 @@
    • INumberingOptions
    +
  • Defined in src/file/numbering/numbering.ts:12
  • @@ -32,9 +34,9 @@

    Properties

    -
    config: readonly { levels: readonly ILevelsOptions[]; reference: string }[]
    +
  • Defined in src/file/numbering/numbering.ts:13
  • @@ -18,7 +20,7 @@
    • IPageMarginAttributes
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:13
  • @@ -40,37 +42,37 @@
    bottom?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:16
  • footer?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:19
  • gutter?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:20
  • header?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:18
  • left?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:17
  • right?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:15
  • top?: string | number
    +
  • Defined in src/file/document/body/section-properties/properties/page-margin.ts:14
  • @@ -20,7 +22,7 @@
    • IParagraphOptions
    +
  • Defined in src/file/paragraph/paragraph.ts:37
  • @@ -61,22 +63,22 @@
    alignment?: AlignmentType
    +
  • Defined in src/file/paragraph/properties.ts:19
  • bidirectional?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:43
  • +
  • Defined in src/file/paragraph/properties.ts:41
  • -
    bullet?: { level: number }
    +
    bullet?: {
        level: number;
    }

    Type declaration

      @@ -84,57 +86,57 @@
      Readonly level: number
    +
  • Defined in src/file/paragraph/properties.ts:47
  • children?: readonly ParagraphChild[]
    +
  • Defined in src/file/paragraph/paragraph.ts:39
  • contextualSpacing?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:21
  • +
  • Defined in src/file/paragraph/properties.ts:52
  • heading?: HeadingLevel
    +
  • Defined in src/file/paragraph/properties.ts:42
  • +
  • Defined in src/file/paragraph/properties.ts:24
  • keepLines?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:27
  • keepNext?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:26
  • leftTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:23
  • -
    numbering?: { custom?: boolean; instance?: number; level: number; reference: string }
    +
    numbering?: {
        custom?: boolean;
        instance?: number;
        level: number;
        reference: string;
    }

    Type declaration

      @@ -148,78 +150,78 @@
      Readonly reference: string
    +
  • Defined in src/file/paragraph/properties.ts:32
  • outlineLevel?: number
    +
  • Defined in src/file/paragraph/properties.ts:28
  • pageBreakBefore?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:44
  • rightTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:22
  • +
  • Defined in src/file/paragraph/properties.ts:50
  • +
  • Defined in src/file/paragraph/properties.ts:25
  • style?: string
    +
  • Defined in src/file/paragraph/properties.ts:46
  • suppressLineNumbers?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:53
  • tabStops?: readonly TabStopDefinition[]
    +
  • Defined in src/file/paragraph/properties.ts:45
  • text?: string
    +
  • Defined in src/file/paragraph/paragraph.ts:38
  • thematicBreak?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:20
  • widowControl?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:51
  • wordWrap?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:54
  • @@ -22,7 +24,7 @@ +
  • Defined in src/file/paragraph/properties.ts:40
  • @@ -61,70 +63,70 @@
    alignment?: AlignmentType
    +
  • Defined in src/file/paragraph/properties.ts:19
  • bidirectional?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:43
  • +
  • Defined in src/file/paragraph/properties.ts:41
  • -
    bullet?: { level: number }
    +
    bullet?: {
        level: number;
    }

    Type declaration

    • Readonly level: number
    +
  • Defined in src/file/paragraph/properties.ts:47
  • contextualSpacing?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:21
  • +
  • Defined in src/file/paragraph/properties.ts:52
  • heading?: HeadingLevel
    +
  • Defined in src/file/paragraph/properties.ts:42
  • +
  • Defined in src/file/paragraph/properties.ts:24
  • keepLines?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:27
  • keepNext?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:26
  • leftTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:23
  • -
    numbering?: { custom?: boolean; instance?: number; level: number; reference: string }
    +
    numbering?: {
        custom?: boolean;
        instance?: number;
        level: number;
        reference: string;
    }

    Type declaration

      @@ -138,66 +140,66 @@
      Readonly reference: string
    +
  • Defined in src/file/paragraph/properties.ts:32
  • outlineLevel?: number
    +
  • Defined in src/file/paragraph/properties.ts:28
  • pageBreakBefore?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:44
  • rightTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:22
  • +
  • Defined in src/file/paragraph/properties.ts:50
  • +
  • Defined in src/file/paragraph/properties.ts:25
  • style?: string
    +
  • Defined in src/file/paragraph/properties.ts:46
  • suppressLineNumbers?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:53
  • tabStops?: readonly TabStopDefinition[]
    +
  • Defined in src/file/paragraph/properties.ts:45
  • thematicBreak?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:20
  • widowControl?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:51
  • wordWrap?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:54
  • @@ -20,7 +22,7 @@
    • IParagraphStyleOptions
    +
  • Defined in src/file/styles/style/paragraph-style.ts:10
  • @@ -47,66 +49,66 @@
    basedOn?: string
    +
  • Defined in src/file/styles/style/style.ts:44
  • id: string
    +
  • Defined in src/file/styles/style/paragraph-style.ts:11
  • link?: string
    +
  • Defined in src/file/styles/style/style.ts:46
  • name?: string
    +
  • Defined in src/file/styles/style/paragraph-style.ts:12
  • next?: string
    +
  • Defined in src/file/styles/style/style.ts:45
  • +
  • Defined in src/file/styles/style/paragraph-style.ts:6
  • quickFormat?: boolean
    +
  • Defined in src/file/styles/style/style.ts:50
  • +
  • Defined in src/file/styles/style/paragraph-style.ts:7
  • semiHidden?: boolean
    +
  • Defined in src/file/styles/style/style.ts:48
  • uiPriority?: number
    +
  • Defined in src/file/styles/style/style.ts:47
  • unhideWhenUsed?: boolean
    +
  • Defined in src/file/styles/style/style.ts:49
  • @@ -22,7 +24,7 @@ +
  • Defined in src/file/paragraph/properties.ts:31
  • @@ -49,40 +51,40 @@
    alignment?: AlignmentType
    +
  • Defined in src/file/paragraph/properties.ts:19
  • contextualSpacing?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:21
  • +
  • Defined in src/file/paragraph/properties.ts:24
  • keepLines?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:27
  • keepNext?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:26
  • leftTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:23
  • -
    numbering?: { custom?: boolean; instance?: number; level: number; reference: string }
    +
    numbering?: {
        custom?: boolean;
        instance?: number;
        level: number;
        reference: string;
    }

    Type declaration

      @@ -95,31 +97,31 @@
    • Readonly reference: string
    +
  • Defined in src/file/paragraph/properties.ts:32
  • outlineLevel?: number
    +
  • Defined in src/file/paragraph/properties.ts:28
  • rightTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:22
  • +
  • Defined in src/file/paragraph/properties.ts:25
  • thematicBreak?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:20
  • @@ -22,7 +24,7 @@ +
  • Defined in src/file/paragraph/run/run.ts:13
  • @@ -67,62 +69,62 @@
    allCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:34
  • bold?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:18
  • boldComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:19
  • +
  • Defined in src/file/paragraph/run/properties.ts:47
  • break?: number
    +
  • Defined in src/file/paragraph/run/run.ts:15
  • characterSpacing?: number
    +
  • Defined in src/file/paragraph/run/properties.ts:42
  • children?: readonly (string | FootnoteReferenceRun | FieldInstruction | Begin | Separate | End)[]
    +
  • Defined in src/file/paragraph/run/run.ts:14
  • color?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:29
  • doubleStrike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:36
  • emboss?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:44
  • -
    emphasisMark?: { type?: DOT }
    +
    emphasisMark?: {
        type?: DOT;
    }

    Type declaration

      @@ -130,111 +132,111 @@
      Optional Readonly type?: DOT
    +
  • Defined in src/file/paragraph/run/properties.ts:26
  • font?: string | IFontAttributesProperties | IFontOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:39
  • highlight?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:40
  • highlightComplexScript?: string | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:41
  • imprint?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:45
  • italics?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:20
  • italicsComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:21
  • +
  • Defined in src/file/paragraph/run/properties.ts:46
  • rightToLeft?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:32
  • +
  • Defined in src/file/paragraph/run/properties.ts:43
  • size?: string | number
    +
  • Defined in src/file/paragraph/run/properties.ts:30
  • sizeComplexScript?: string | number | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:31
  • smallCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:33
  • strike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:35
  • style?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:51
  • subScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:37
  • superScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:38
  • text?: string
    +
  • Defined in src/file/paragraph/run/run.ts:16
  • -
    underline?: { color?: string; type?: UnderlineType }
    +
    underline?: {
        color?: string;
        type?: UnderlineType;
    }

    Type declaration

    +
  • Defined in src/file/paragraph/run/properties.ts:22
  • @@ -21,7 +23,7 @@
    • IRunPropertiesChangeOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:54
  • @@ -66,64 +68,64 @@
    allCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:34
  • author: string
    +
  • Defined in src/file/track-revision/track-revision.ts:5
  • bold?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:18
  • boldComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:19
  • +
  • Defined in src/file/paragraph/run/properties.ts:47
  • characterSpacing?: number
    +
  • Defined in src/file/paragraph/run/properties.ts:42
  • color?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:29
  • date: string
    +
  • Defined in src/file/track-revision/track-revision.ts:6
  • doubleStrike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:36
  • emboss?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:44
  • -
    emphasisMark?: { type?: DOT }
    +
    emphasisMark?: {
        type?: DOT;
    }

    Type declaration

      @@ -131,112 +133,112 @@
      Optional Readonly type?: DOT
    +
  • Defined in src/file/paragraph/run/properties.ts:26
  • font?: string | IFontAttributesProperties | IFontOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:39
  • highlight?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:40
  • highlightComplexScript?: string | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:41
  • id: number
    +
  • Defined in src/file/track-revision/track-revision.ts:4
  • imprint?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:45
  • italics?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:20
  • italicsComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:21
  • +
  • Defined in src/file/paragraph/run/properties.ts:46
  • rightToLeft?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:32
  • +
  • Defined in src/file/paragraph/run/properties.ts:43
  • size?: string | number
    +
  • Defined in src/file/paragraph/run/properties.ts:30
  • sizeComplexScript?: string | number | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:31
  • smallCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:33
  • strike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:35
  • style?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:51
  • subScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:37
  • superScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:38
  • -
    underline?: { color?: string; type?: UnderlineType }
    +
    underline?: {
        color?: string;
        type?: UnderlineType;
    }

    Type declaration

    +
  • Defined in src/file/paragraph/run/properties.ts:22
  • @@ -23,7 +25,7 @@
  • IRunOptions
  • IRunPropertiesChangeOptions
  • +
  • Defined in src/file/paragraph/run/properties.ts:50
  • @@ -65,52 +67,52 @@
    allCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:34
  • bold?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:18
  • boldComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:19
  • +
  • Defined in src/file/paragraph/run/properties.ts:47
  • characterSpacing?: number
    +
  • Defined in src/file/paragraph/run/properties.ts:42
  • color?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:29
  • doubleStrike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:36
  • emboss?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:44
  • -
    emphasisMark?: { type?: DOT }
    +
    emphasisMark?: {
        type?: DOT;
    }

    Type declaration

      @@ -118,105 +120,105 @@
      Optional Readonly type?: DOT
    +
  • Defined in src/file/paragraph/run/properties.ts:26
  • font?: string | IFontAttributesProperties | IFontOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:39
  • highlight?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:40
  • highlightComplexScript?: string | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:41
  • imprint?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:45
  • italics?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:20
  • italicsComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:21
  • +
  • Defined in src/file/paragraph/run/properties.ts:46
  • rightToLeft?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:32
  • +
  • Defined in src/file/paragraph/run/properties.ts:43
  • size?: string | number
    +
  • Defined in src/file/paragraph/run/properties.ts:30
  • sizeComplexScript?: string | number | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:31
  • smallCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:33
  • strike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:35
  • style?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:51
  • subScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:37
  • superScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:38
  • -
    underline?: { color?: string; type?: UnderlineType }
    +
    underline?: {
        color?: string;
        type?: UnderlineType;
    }

    Type declaration

    +
  • Defined in src/file/paragraph/run/properties.ts:22
  • @@ -20,7 +22,7 @@ +
  • Defined in src/file/paragraph/run/properties.ts:17
  • @@ -60,130 +62,130 @@
    allCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:34
  • bold?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:18
  • boldComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:19
  • +
  • Defined in src/file/paragraph/run/properties.ts:47
  • characterSpacing?: number
    +
  • Defined in src/file/paragraph/run/properties.ts:42
  • color?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:29
  • doubleStrike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:36
  • emboss?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:44
  • -
    emphasisMark?: { type?: DOT }
    +
    emphasisMark?: {
        type?: DOT;
    }

    Type declaration

    • Optional Readonly type?: DOT
    +
  • Defined in src/file/paragraph/run/properties.ts:26
  • font?: string | IFontAttributesProperties | IFontOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:39
  • highlight?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:40
  • highlightComplexScript?: string | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:41
  • imprint?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:45
  • italics?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:20
  • italicsComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:21
  • +
  • Defined in src/file/paragraph/run/properties.ts:46
  • rightToLeft?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:32
  • +
  • Defined in src/file/paragraph/run/properties.ts:43
  • size?: string | number
    +
  • Defined in src/file/paragraph/run/properties.ts:30
  • sizeComplexScript?: string | number | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:31
  • smallCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:33
  • strike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:35
  • subScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:37
  • superScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:38
  • -
    underline?: { color?: string; type?: UnderlineType }
    +
    underline?: {
        color?: string;
        type?: UnderlineType;
    }

    Type declaration

    +
  • Defined in src/file/paragraph/run/properties.ts:22
  • @@ -18,7 +20,7 @@
    • ISectionOptions
    +
  • Defined in src/file/file.ts:24
  • @@ -37,10 +39,10 @@
    children: readonly (Paragraph | Table | TableOfContents)[]
    +
  • Defined in src/file/file.ts:36
  • -
    footers?: { default?: Footer; even?: Footer; first?: Footer }
    +
    footers?: {
        default?: Footer;
        even?: Footer;
        first?: Footer;
    }

    Type declaration

      @@ -51,10 +53,10 @@
    • Optional Readonly first?: Footer
    +
  • Defined in src/file/file.ts:30
  • -
    headers?: { default?: Header; even?: Header; first?: Header }
    +
    headers?: {
        default?: Header;
        even?: Header;
        first?: Header;
    }

    Type declaration

      @@ -65,12 +67,12 @@
    • Optional Readonly first?: Header
    +
  • Defined in src/file/file.ts:25
  • +
  • Defined in src/file/file.ts:35
  • @@ -18,7 +20,7 @@
    • ISectionPropertiesOptions
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:27
  • @@ -42,30 +44,30 @@
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:41
  • footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:37
  • +
  • Defined in src/file/document/body/section-properties/section-properties.ts:35
  • headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:36
  • lineNumbers?: ILineNumberAttributes
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:38
  • -
    page?: { borders?: IPageBordersOptions; margin?: IPageMarginAttributes; pageNumbers?: IPageNumberTypeAttributes; size?: IPageSizeAttributes; textDirection?: PageTextDirectionType }
    +
    page?: {
        borders?: IPageBordersOptions;
        margin?: IPageMarginAttributes;
        pageNumbers?: IPageNumberTypeAttributes;
        size?: IPageSizeAttributes;
        textDirection?: PageTextDirectionType;
    }

    Type declaration

    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:28
  • titlePage?: boolean
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:39
  • +
  • Defined in src/file/document/body/section-properties/section-properties.ts:42
  • verticalAlign?: VerticalAlign
    +
  • Defined in src/file/document/body/section-properties/section-properties.ts:40
  • @@ -18,7 +20,7 @@
    • IShadingAttributesProperties
    +
  • Defined in src/file/shading/shading.ts:23
  • @@ -36,17 +38,17 @@
    color?: string
    +
  • Defined in src/file/shading/shading.ts:25
  • fill?: string
    +
  • Defined in src/file/shading/shading.ts:24
  • +
  • Defined in src/file/shading/shading.ts:26
  • @@ -18,7 +20,7 @@
    • ISpacingProperties
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:9
  • @@ -39,32 +41,32 @@
    after?: number
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:10
  • afterAutoSpacing?: boolean
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:15
  • before?: number
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:11
  • beforeAutoSpacing?: boolean
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:14
  • line?: number
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:12
  • lineRule?: LineRuleType
    +
  • Defined in src/file/paragraph/formatting/spacing.ts:13
  • @@ -18,7 +20,7 @@
    • IStylesOptions
    +
  • Defined in src/file/styles/styles.ts:7
  • @@ -38,27 +40,27 @@
    characterStyles?: readonly ICharacterStyleOptions[]
    +
  • Defined in src/file/styles/styles.ts:11
  • default?: IDefaultStylesOptions
    +
  • Defined in src/file/styles/styles.ts:8
  • +
  • Defined in src/file/styles/styles.ts:12
  • initialStyles?: BaseXmlComponent
    +
  • Defined in src/file/styles/styles.ts:9
  • paragraphStyles?: readonly IParagraphStyleOptions[]
    +
  • Defined in src/file/styles/styles.ts:10
  • @@ -20,7 +22,7 @@
    • ISymbolRunOptions
    +
  • Defined in src/file/paragraph/run/symbol-run.ts:4
  • @@ -67,69 +69,69 @@
    allCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:34
  • bold?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:18
  • boldComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:19
  • +
  • Defined in src/file/paragraph/run/properties.ts:47
  • break?: number
    +
  • Defined in src/file/paragraph/run/run.ts:15
  • char: string
    +
  • Defined in src/file/paragraph/run/symbol-run.ts:5
  • characterSpacing?: number
    +
  • Defined in src/file/paragraph/run/properties.ts:42
  • children?: readonly (string | FootnoteReferenceRun | FieldInstruction | Begin | Separate | End)[]
    +
  • Defined in src/file/paragraph/run/run.ts:14
  • color?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:29
  • doubleStrike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:36
  • emboss?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:44
  • -
    emphasisMark?: { type?: DOT }
    +
    emphasisMark?: {
        type?: DOT;
    }

    Type declaration

      @@ -137,117 +139,117 @@
      Optional Readonly type?: DOT
    +
  • Defined in src/file/paragraph/run/properties.ts:26
  • font?: string | IFontAttributesProperties | IFontOptions
    +
  • Defined in src/file/paragraph/run/properties.ts:39
  • highlight?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:40
  • highlightComplexScript?: string | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:41
  • imprint?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:45
  • italics?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:20
  • italicsComplexScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:21
  • +
  • Defined in src/file/paragraph/run/properties.ts:46
  • rightToLeft?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:32
  • +
  • Defined in src/file/paragraph/run/properties.ts:43
  • size?: string | number
    +
  • Defined in src/file/paragraph/run/properties.ts:30
  • sizeComplexScript?: string | number | boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:31
  • smallCaps?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:33
  • strike?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:35
  • style?: string
    +
  • Defined in src/file/paragraph/run/properties.ts:51
  • subScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:37
  • superScript?: boolean
    +
  • Defined in src/file/paragraph/run/properties.ts:38
  • symbolfont?: string
    +
  • Defined in src/file/paragraph/run/symbol-run.ts:6
  • text?: string
    +
  • Defined in src/file/paragraph/run/run.ts:16
  • -
    underline?: { color?: string; type?: UnderlineType }
    +
    underline?: {
        color?: string;
        type?: UnderlineType;
    }

    Type declaration

    +
  • Defined in src/file/paragraph/run/properties.ts:22
  • @@ -20,7 +22,7 @@
    • ITableCellOptions
    +
  • Defined in src/file/table/table-cell/table-cell.ts:8
  • @@ -46,60 +48,60 @@
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:26
  • children: readonly (Paragraph | Table)[]
    +
  • Defined in src/file/table/table-cell/table-cell.ts:9
  • columnSpan?: number
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:24
  • margins?: ITableCellMarginOptions
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:19
  • rowSpan?: number
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:25
  • +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:18
  • textDirection?: TextDirection
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:21
  • verticalAlign?: VerticalAlign
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:20
  • verticalMerge?: VerticalMergeType
    +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:22
  • +
  • Defined in src/file/table/table-cell/table-cell-properties.ts:23
  • @@ -18,7 +20,7 @@
    • ITableFloatOptions
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:29
  • @@ -50,7 +52,7 @@ If relativeHorizontalPosition is also specified, then the absoluteHorizontalPosi If the attribute is omitted, the value is assumed to be zero.

    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:49
  • absoluteVerticalPosition?: string | number
    @@ -61,7 +63,7 @@ If relativeVerticalPosition is also specified, then the absoluteVerticalPosition If the attribute is omitted, the value is assumed to be zero.

    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:80
  • bottomFromText?: string | number
    @@ -69,7 +71,7 @@ If the attribute is omitted, the value is assumed to be zero.

    below the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.

    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:98
  • horizontalAnchor?: TableAnchorType
    @@ -81,7 +83,7 @@ text - relative to the vertical edge of the text margin for the column in which If omitted, the value is assumed to be page.

    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:40
  • leftFromText?: string | number
    @@ -89,12 +91,12 @@ If omitted, the value is assumed to be page.

    to the left of the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.

    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:110
  • overlap?: OverlapType
    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:117
  • relativeHorizontalPosition?: RelativeHorizontalPosition
    @@ -108,7 +110,7 @@ outside - the table should be outside of the anchor right - the table should be right aligned with respect to the anchor

    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:61
  • relativeVerticalPosition?: RelativeVerticalPosition
    @@ -122,7 +124,7 @@ inline - the table should be vertically aligned in line with the surrounding tex top - the table should be vertically aligned to the top edge of the anchor

    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:92
  • rightFromText?: string | number
    @@ -130,7 +132,7 @@ top - the table should be vertically aligned to the top edge of the anchor

    to the right of the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.

    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:116
  • topFromText?: string | number
    @@ -138,7 +140,7 @@ to the right of the table. The value is in twentieths of a point. If omitted, th above the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.

    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:104
  • verticalAnchor?: TableAnchorType
    @@ -150,7 +152,7 @@ text - relative to the horizontal edge of the text margin for the column in whic If omitted, the value is assumed to be page.

    +
  • Defined in src/file/table/table-properties/table-float-properties.ts:71
  • @@ -25,7 +27,7 @@ Part 1 - Page 1251

    • ITableOfContentsOptions
    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:19
  • @@ -60,7 +62,7 @@ The identifier designated by text in this switch's field-argument correspond Use captionLabelIncludingNumbers (\c) to build a table of captions with labels and numbers.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:25
  • captionLabelIncludingNumbers?: string
    @@ -70,7 +72,7 @@ field-argument, which corresponds to the caption label, shall match the identifi corresponding SEQ field.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:39
  • entriesFromBookmark?: string
    @@ -78,7 +80,7 @@ corresponding SEQ field.

    the bookmark named by text in this switch's field-argument.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:31
  • entryAndPageNumberSeparator?: string
    @@ -86,7 +88,7 @@ the bookmark named by text in this switch's field-argument.

    that separate an entry and its page number. The default is a tab with leader dots.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:86
  • headingStyleRange?: string
    @@ -97,21 +99,21 @@ to the style with a style ID of HeadingX (e.g. 1 corresponds to Heading1). If no heading range is specified, all heading levels used in the document are listed.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:80
  • hideTabAndPageNumbersInWebView?: boolean

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

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:121
  • hyperlink?: boolean

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

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:56
  • pageNumbersEntryLevelsRange?: string
    @@ -120,21 +122,21 @@ Page numbers are omitted from all levels unless a range of entry levels is speci text in this switch's field-argument. A range is specified as for \l.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:71
  • preserveNewLineInEntries?: boolean

    \x Preserves newline characters within table entries.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:116
  • preserveTabInEntries?: boolean

    \w Preserves tab entries within table entries.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:111
  • seqFieldIdentifierForPrefix?: string
    @@ -143,7 +145,7 @@ The prefix depends on the type of entry. text in this switch's field-argumen identifier in the SEQ field.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:93
  • sequenceAndPageNumbersSeparator?: string
    @@ -151,7 +153,7 @@ identifier in the SEQ field.

    the separator between sequence and page numbers. The default separator is a hyphen (-).

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:45
  • stylesWithLevels?: readonly StyleLevel[]
    @@ -161,7 +163,7 @@ with each doublet being a comma-separated set of style name and table of content \t can be combined with \o.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:101
  • tcFieldIdentifier?: string
    @@ -169,7 +171,7 @@ with each doublet being a comma-separated set of style name and table of content text in this switch's field-argument (which is typically a letter).

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:51
  • tcFieldLevelRange?: string
    @@ -179,14 +181,14 @@ where startLevel and endLevel are integers, and startLevel has a value equal-to TC fields that assign entries to lower levels are skipped.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:64
  • useAppliedParagraphOutlineLevel?: boolean

    \u Uses the applied paragraph outline level.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:106
  • @@ -18,7 +20,7 @@
    • ITableOptions
    +
  • Defined in src/file/table/table.ts:23
  • @@ -44,57 +46,57 @@
    alignment?: AlignmentType
    +
  • Defined in src/file/table/table.ts:33
  • +
  • Defined in src/file/table/table.ts:32
  • columnWidths?: readonly number[]
    +
  • Defined in src/file/table/table.ts:26
  • +
  • Defined in src/file/table/table.ts:29
  • +
  • Defined in src/file/table/table.ts:28
  • +
  • Defined in src/file/table/table.ts:30
  • margins?: ITableCellMarginOptions
    +
  • Defined in src/file/table/table.ts:27
  • rows: readonly TableRow[]
    +
  • Defined in src/file/table/table.ts:24
  • style?: string
    +
  • Defined in src/file/table/table.ts:31
  • visuallyRightToLeft?: boolean
    +
  • Defined in src/file/table/table.ts:34
  • +
  • Defined in src/file/table/table.ts:25
  • @@ -18,7 +20,7 @@
    • ITablePropertiesOptions
    +
  • Defined in src/file/table/table-properties/table-properties.ts:34
  • @@ -43,52 +45,52 @@
    alignment?: AlignmentType
    +
  • Defined in src/file/table/table-properties/table-properties.ts:42
  • +
  • Defined in src/file/table/table-properties/table-properties.ts:38
  • cellMargin?: ITableCellMarginOptions
    +
  • Defined in src/file/table/table-properties/table-properties.ts:43
  • +
  • Defined in src/file/table/table-properties/table-properties.ts:39
  • +
  • Defined in src/file/table/table-properties/table-properties.ts:36
  • +
  • Defined in src/file/table/table-properties/table-properties.ts:37
  • +
  • Defined in src/file/table/table-properties/table-properties.ts:40
  • style?: string
    +
  • Defined in src/file/table/table-properties/table-properties.ts:41
  • visuallyRightToLeft?: boolean
    +
  • Defined in src/file/table/table-properties/table-properties.ts:44
  • +
  • Defined in src/file/table/table-properties/table-properties.ts:35
  • @@ -20,7 +22,7 @@
    • ITableRowOptions
    +
  • Defined in src/file/table/table-row/table-row.ts:5
  • @@ -40,15 +42,15 @@
    cantSplit?: boolean
    +
  • Defined in src/file/table/table-row/table-row-properties.ts:35
  • children: readonly TableCell[]
    +
  • Defined in src/file/table/table-row/table-row.ts:6
  • -
    height?: { rule: HeightRule; value: string | number }
    +
    height?: {
        rule: HeightRule;
        value: string | number;
    }

    Type declaration

      @@ -58,13 +60,13 @@
      Readonly value: string | number
    +
  • Defined in src/file/table/table-row/table-row-properties.ts:37
  • tableHeader?: boolean
    +
  • Defined in src/file/table/table-row/table-row-properties.ts:36
  • @@ -20,7 +22,7 @@ +
  • Defined in src/file/table/table-row/table-row-properties.ts:34
  • @@ -38,10 +40,10 @@
    cantSplit?: boolean
    +
  • Defined in src/file/table/table-row/table-row-properties.ts:35
  • -
    height?: { rule: HeightRule; value: string | number }
    +
    height?: {
        rule: HeightRule;
        value: string | number;
    }

    Type declaration

      @@ -50,12 +52,12 @@
    • Readonly value: string | number
    +
  • Defined in src/file/table/table-row/table-row-properties.ts:37
  • tableHeader?: boolean
    +
  • Defined in src/file/table/table-row/table-row-properties.ts:36
  • @@ -18,7 +20,7 @@
    • ITableWidthProperties
    +
  • Defined in src/file/table/table-width.ts:28
  • @@ -35,12 +37,12 @@
    size: string | number
    +
  • Defined in src/file/table/table-width.ts:29
  • type?: WidthType
    +
  • Defined in src/file/table/table-width.ts:30
  • @@ -20,7 +22,7 @@
    • IXYFrameOptions
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:45
  • @@ -43,7 +45,7 @@

    Properties

    -
    anchor: { horizontal: FrameAnchorType; vertical: FrameAnchorType }
    +
    anchor: {
        horizontal: FrameAnchorType;
        vertical: FrameAnchorType;
    }

    Type declaration

    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:34
  • anchorLock?: boolean
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:28
  • dropCap?: DropCapType
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:29
  • height: number
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:31
  • lines?: number
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:33
  • -
    position: { x: number; y: number }
    +
    position: {
        x: number;
        y: number;
    }

    Type declaration

      @@ -89,16 +91,16 @@
    • Readonly y: number
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:46
  • rule?: HeightRule
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:42
  • -
    space?: { horizontal: number; vertical: number }
    +
    space?: {
        horizontal: number;
        vertical: number;
    }

    Type declaration

      @@ -108,19 +110,19 @@
      Readonly vertical: number
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:38
  • width: number
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:30
  • wrap?: FrameWrap
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:32
  • @@ -21,7 +23,7 @@

    Indexable

    [key: string]: string | number | boolean
    +
  • Defined in src/file/xml-components/xmlable-object.ts:1
  • @@ -20,7 +22,7 @@
    • IXmlableObject
    +
  • Defined in src/file/xml-components/xmlable-object.ts:4
  • @@ -47,7 +49,7 @@
    +
  • Defined in src/file/xml-components/xmlable-object.ts:5
  • constructor: Function
    diff --git a/api/interfaces/TabStopDefinition.html b/api/interfaces/TabStopDefinition.html index 9a28fba4ba..063595c7f5 100644 --- a/api/interfaces/TabStopDefinition.html +++ b/api/interfaces/TabStopDefinition.html @@ -1,11 +1,13 @@ TabStopDefinition | docx
    -
    +
  • The search index is not available
  • docx
    +
    @@ -18,7 +20,7 @@
    • TabStopDefinition
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:4
  • @@ -36,17 +38,17 @@
    leader?: LeaderType
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:7
  • position: number
    +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:6
  • +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:5
  • diff --git a/api/types/AttributeMap.html b/api/types/AttributeMap.html index e6a292a888..ef1fdb94cf 100644 --- a/api/types/AttributeMap.html +++ b/api/types/AttributeMap.html @@ -1,11 +1,13 @@ AttributeMap | docx
    -
    +
  • The search index is not available
  • docx
    +
    @@ -15,7 +17,7 @@

    Type alias IFrameOptions

    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:61
  • @@ -18,7 +20,7 @@

    Type declaration

      +
    • Defined in src/file/xml-components/xml-component.ts:4
    • @@ -13,7 +15,7 @@
    • docx
    • sectionMarginDefaults
    • Variable sectionMarginDefaultsConst

      -
      sectionMarginDefaults: { BOTTOM: string; FOOTER: number; GUTTER: number; HEADER: number; LEFT: string; RIGHT: string; TOP: string } = ...
      +
      sectionMarginDefaults: {
          BOTTOM: string;
          FOOTER: number;
          GUTTER: number;
          HEADER: number;
          LEFT: string;
          RIGHT: string;
          TOP: string;
      } = ...

      Type declaration

        @@ -32,7 +34,7 @@
      • TOP: string
      +
    • Defined in src/file/document/body/section-properties/section-properties.ts:78
    • @@ -13,7 +15,7 @@
    • docx
    • sectionPageSizeDefaults
    • Variable sectionPageSizeDefaultsConst

      -
      sectionPageSizeDefaults: { HEIGHT: number; ORIENTATION: PageOrientation; WIDTH: number } = ...
      +
      sectionPageSizeDefaults: {
          HEIGHT: number;
          ORIENTATION: PageOrientation;
          WIDTH: number;
      } = ...

      Type declaration

        @@ -24,7 +26,7 @@
      • WIDTH: number
      +
    • Defined in src/file/document/body/section-properties/section-properties.ts:88