diff --git a/_sidebar.md b/_sidebar.md index feb12f2452..959b96aa94 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -9,21 +9,21 @@ - Usage - [Document](usage/document.md) - - [Sections](usage/sections.md) + - [Sections](usage/sections.md) - [Paragraph](usage/paragraph.md) - [Text](usage/text.md) - [Image](usage/images.md) - [Headers & Footers](usage/headers-and-footers.md) - [Bullet Points](usage/bullet-points.md) - - [Hyperlinks](usage/hyperlinks.md) - - [Numbering](usage/numbering.md) - - [Tables](usage/tables.md) + - [Hyperlinks](usage/hyperlinks.md) + - [Numbering](usage/numbering.md) + - [Tables](usage/tables.md) - [Tab Stops](usage/tab-stops.md) - - [Table of Contents](usage/table-of-contents.md) - - [Page Numbers](usage/page-numbers.md) - - [Change Tracking](usage/change-tracking.md) - - [Math](usage/math.md) - - [Text Frames](usage/text-frames.md) + - [Table of Contents](usage/table-of-contents.md) + - [Page Numbers](usage/page-numbers.md) + - [Change Tracking](usage/change-tracking.md) + - [Math](usage/math.md) + - [Text Frames](usage/text-frames.md) - Styling _ [Styling with JS](usage/styling-with-js.md) _ [Styling with XML](usage/styling-with-xml.md) diff --git a/api/classes/AbstractNumbering.html b/api/classes/AbstractNumbering.html index e04a464f93..a76799b291 100644 --- a/api/classes/AbstractNumbering.html +++ b/api/classes/AbstractNumbering.html @@ -60,7 +60,7 @@
id: number
+
  • Defined in src/file/numbering/abstract-numbering.ts:33
  • Methods

    diff --git a/api/classes/Bookmark.html b/api/classes/Bookmark.html index 2aba99b1f7..b62c040708 100644 --- a/api/classes/Bookmark.html +++ b/api/classes/Bookmark.html @@ -57,17 +57,17 @@
    children: ParagraphChild[]
    +
  • Defined in src/file/paragraph/links/bookmark.ts:10
  • end: BookmarkEnd
    +
  • Defined in src/file/paragraph/links/bookmark.ts:11
  • start: BookmarkStart
    +
  • Defined in src/file/paragraph/links/bookmark.ts:9
  • +
  • Defined in src/file/paragraph/links/hyperlink.ts:42
  • +
  • Defined in src/file/paragraph/formatting/alignment.ts:6
  • +
  • Defined in src/file/paragraph/frame/frame-properties.ts:34
  • 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 }
    @@ -106,19 +106,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 }
    @@ -66,12 +66,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
    @@ -67,7 +67,7 @@ If the attribute is omitted, the value is assumed to be zero.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    +
  • Defined in src/file/table-of-contents/table-of-contents-properties.ts:64
  • 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 }
    @@ -106,19 +106,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