diff --git a/api/classes/AbstractNumbering.html b/api/classes/AbstractNumbering.html index e0f6d002ba..167ac25f3a 100644 --- a/api/classes/AbstractNumbering.html +++ b/api/classes/AbstractNumbering.html @@ -22,7 +22,7 @@ +
  • Defined in src/file/numbering/abstract-numbering.ts:32
  • @@ -58,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

    @@ -81,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
  • Returns undefined | IXmlableObject

    +
  • Defined in src/file/xml-components/base.ts:17
  • Returns void

    +
  • Defined in src/file/document/body/body.ts:21
  • +
  • Defined in src/file/document/body/body.ts:28
  • Returns void

    +
  • Defined in src/file/document/body/body.ts:37
  • +
  • Defined in src/file/paragraph/links/bookmark.ts:9
  • +
  • Defined in src/file/file.ts:257
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • +
  • Defined in src/file/header.ts:13
  • Returns void

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

    +
  • Defined in src/file/footer-wrapper.ts:29
  • +
  • Defined in src/file/header.ts:9
  • Returns HeaderWrapper

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

    +
  • Defined in src/file/header-wrapper.ts:31
  • +
  • Defined in src/import-dotx/import-dotx.ts:48
  • Returns ImportedXmlComponent

    +
  • Defined in src/file/xml-components/imported-xml-component.ts:44
  • Returns IMediaData

    +
  • Defined in src/file/media/media.ts:22
  • +
  • Defined in src/file/numbering/numbering.ts:182
  • Returns Promise<Blob>

    +
  • Defined in src/export/packer/packer.ts:49
  • Returns Promise<Buffer>

    +
  • Defined in src/export/packer/packer.ts:27
  • Returns Promise<string>

    +
  • Defined in src/export/packer/packer.ts:16
  • +
  • Defined in src/file/paragraph/paragraph.ts:79
  • +
  • Defined in src/file/paragraph/properties.ts:177
  • +
  • Defined in src/file/paragraph/run/properties.ts:222
  • +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:2
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • Returns void

    +
  • Defined in src/file/table/table-row/table-row.ts:27
  • +
  • Defined in src/file/xml-components/xml-component.ts:34
  • Returns number

    +
  • Defined in src/file/table/table-row/table-row.ts:51
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • Returns number

    +
  • Defined in src/file/table/table-row/table-row.ts:37
  • +
  • Defined in src/file/xml-components/xml-component.ts:15
  • +
  • Defined in src/file/paragraph/formatting/alignment.ts:6
  • +
  • Defined in src/file/border/border.ts:85
  • +
  • Defined in src/file/document/body/section-properties/properties/doc-grid.ts:24
  • +
  • Defined in src/file/paragraph/frame/frame-properties.ts:7
  • +
  • Defined in src/file/paragraph/run/emphasis-mark.ts:4
  • +
  • Defined in src/file/paragraph/frame/frame-properties.ts:15
  • +
  • Defined in src/file/paragraph/frame/frame-properties.ts:24
  • +
  • Defined in src/file/document/body/section-properties/properties/header-footer-reference.ts:12
  • +
  • Defined in src/file/document/body/section-properties/properties/header-footer-reference.ts:51
  • +
  • Defined in src/file/paragraph/formatting/style.ts:10
  • +
  • Defined in src/file/table/table-row/table-row-height.ts:22
  • +
  • Defined in src/file/shared/alignment.ts:6
  • +
  • Defined in src/file/drawing/floating/floating-position.ts:15
  • +
  • Defined in src/file/paragraph/links/hyperlink.ts:9
  • +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:28
  • +
  • Defined in src/file/numbering/level.ts:23
  • +
  • Defined in src/file/numbering/level.ts:80
  • +
  • Defined in src/file/document/body/section-properties/properties/line-number.ts:14
  • +
  • Defined in src/file/paragraph/formatting/spacing.ts:6
  • +
  • Defined in src/file/shared/number-format.ts:114
  • +
  • Defined in src/file/table/table-properties/table-overlap.ts:11
  • +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:15
  • +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:26
  • +
  • Defined in src/file/document/body/section-properties/properties/page-borders.ts:37
  • +
  • Defined in src/file/paragraph/run/run.ts:23
  • +
  • Defined in src/file/document/body/section-properties/properties/page-number.ts:17
  • +
  • Defined in src/file/document/body/section-properties/properties/page-size.ts:11
  • +
  • Defined in src/file/document/body/section-properties/properties/page-text-direction.ts:5
  • +
  • Defined in src/file/table/table-properties/table-float-properties.ts:17
  • +
  • Defined in src/file/table/table-properties/table-float-properties.ts:26
  • +
  • Defined in src/file/document/body/section-properties/properties/section-type.ts:18
  • +
  • Defined in src/file/shading/shading.ts:87
  • +
  • Defined in src/file/space-type.ts:3
  • +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:32
  • +
  • Defined in src/file/paragraph/formatting/tab-stop.ts:20
  • +
  • Defined in src/file/table/table-properties/table-float-properties.ts:9
  • +
  • Defined in src/file/table/table-properties/table-layout.ts:11
  • +
  • Defined in src/file/table/table-cell/table-cell-components.ts:116
  • +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:14
  • +
  • Defined in src/file/drawing/text-wrap/text-wrapping.ts:8
  • +
  • Defined in src/file/paragraph/run/underline.ts:6
  • +
  • Defined in src/file/vertical-align/vertical-align.ts:17
  • +
  • Defined in src/file/shared/alignment.ts:14
  • +
  • Defined in src/file/drawing/floating/floating-position.ts:26
  • +
  • Defined in src/file/table/table-width.ts:21
  • +
  • Defined in src/util/convenience-functions.ts:10
  • +
  • Defined in src/util/convenience-functions.ts:6
  • Returns ImportedXmlComponent | string | undefined

    +
  • Defined in src/file/xml-components/imported-xml-component.ts:11
  • +
  • Defined in src/util/values.ts:225
  • +
  • Defined in src/util/values.ts:10
  • +
  • Defined in src/util/values.ts:20
  • +
  • Defined in src/util/values.ts:119
  • +
  • Defined in src/util/values.ts:139
  • +
  • Defined in src/util/values.ts:46
  • +
  • Defined in src/util/values.ts:185
  • +
  • Defined in src/util/values.ts:162
  • +
  • Defined in src/util/values.ts:20
  • +
  • Defined in src/util/values.ts:97
  • +
  • Defined in src/util/values.ts:55
  • +
  • Defined in src/util/values.ts:146
  • +
  • Defined in src/util/values.ts:132
  • +
  • Defined in src/util/values.ts:153
  • +
  • Defined in src/util/values.ts:64
  • +
  • Defined in src/util/values.ts:79
  • +
  • Defined in src/util/values.ts:20
  • +
  • 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 }
    @@ -110,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
  • +
  • Defined in src/file/numbering/num.ts:24
  • +
  • Defined in src/file/numbering/level.ts:86
  • +
  • Defined in src/file/media/data.ts:10
  • pixels: { x: number; y: number }
    @@ -68,12 +68,12 @@
  • Readonly y: number
  • +
  • Defined in src/file/media/data.ts:2
  • rotation?: number
    +
  • Defined in src/file/media/data.ts:14
  • +
  • Defined in src/file/media/media.ts:6
  • +
  • Defined in src/file/paragraph/properties.ts:31
  • outlineLevel?: number
    +
  • Defined in src/file/paragraph/properties.ts:27
  • pageBreakBefore?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:43
  • rightTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:21
  • shading?: IShadingAttributesProperties
    +
  • Defined in src/file/paragraph/properties.ts:53
  • spacing?: ISpacingProperties
    +
  • Defined in src/file/paragraph/properties.ts:24
  • style?: string
    +
  • Defined in src/file/paragraph/properties.ts:49
  • suppressLineNumbers?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:56
  • tabStops?: { leader?: LeaderType; position: number; type: TabStopType }[]
    +
  • Defined in src/file/paragraph/properties.ts:44
  • text?: string
    +
  • Defined in src/file/paragraph/paragraph.ts:38
  • thematicBreak?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:19
  • widowControl?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:54
  • +
  • Defined in src/file/paragraph/properties.ts:31
  • outlineLevel?: number
    +
  • Defined in src/file/paragraph/properties.ts:27
  • pageBreakBefore?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:43
  • rightTabStop?: number
    +
  • Defined in src/file/paragraph/properties.ts:21
  • shading?: IShadingAttributesProperties
    +
  • Defined in src/file/paragraph/properties.ts:53
  • spacing?: ISpacingProperties
    +
  • Defined in src/file/paragraph/properties.ts:24
  • style?: string
    +
  • Defined in src/file/paragraph/properties.ts:49
  • suppressLineNumbers?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:56
  • tabStops?: { leader?: LeaderType; position: number; type: TabStopType }[]
    +
  • Defined in src/file/paragraph/properties.ts:44
  • thematicBreak?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:19
  • widowControl?: boolean
    +
  • Defined in src/file/paragraph/properties.ts:54
  • +
  • Defined in src/file/paragraph/properties.ts:19
  • +
  • Defined in src/file/paragraph/run/properties.ts:23
  • +
  • Defined in src/file/paragraph/run/properties.ts:23
  • +
  • Defined in src/file/paragraph/run/properties.ts:23
  • +
  • Defined in src/file/paragraph/run/properties.ts:23
  • +
  • Defined in src/file/file.ts:25
  • properties?: ISectionPropertiesOptions
    +
  • Defined in src/file/file.ts:35
  • +
  • Defined in src/file/document/body/section-properties/section-properties.ts:40
  • +
  • Defined in src/file/paragraph/run/properties.ts:23
  • +
  • Defined in src/file/table/table-properties/table-float-properties.ts:80
  • bottomFromText?: string | number
    @@ -69,7 +69,7 @@ If the attribute is omitted, the value is assumed to be zero.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:80
  • 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 +120,21 @@ Page numbers are omitted from all levels unless a range of entry levels is speci text in this switch's field-argument. A range is specified as for \l.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:71
  • 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 +143,7 @@ The prefix depends on the type of entry. text in this switch's field-argumen identifier in the SEQ field.

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

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

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

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

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

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

    \u Uses the applied paragraph outline level.

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:106
  • +
  • Defined in src/file/table/table-row/table-row-properties.ts:36
  • +
  • Defined in src/file/table/table-row/table-row-properties.ts:36
  • +
  • Defined in src/file/paragraph/frame/frame-properties.ts:46
  • rule?: HeightRule
    +
  • Defined in src/file/paragraph/frame/frame-properties.ts:42
  • space?: { horizontal: number; vertical: number }
    @@ -110,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
  • +
  • Defined in src/file/paragraph/frame/frame-properties.ts:61
  • +
  • Defined in src/file/paragraph/math/math-component.ts:9
  • +
  • Defined in src/file/paragraph/paragraph.ts:15
  • +
  • Defined in src/file/xml-components/xml-component.ts:4
  • +
  • Defined in src/file/document/body/section-properties/section-properties.ts:78
  • +
  • Defined in src/file/document/body/section-properties/section-properties.ts:88