DsPdfJS API - v9.1.0
    Preparing search index...

    Class SplitOptions

    Represents the options for text splitting.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    addSpacingAfterLastLine allowMovingAllToRest id keepParagraphLinesTogether lineGapBeforeFirstLine minLinesInFirstParagraph minLinesInLastParagraph om restColumnWidth restMarginBottom restMarginLeft restMarginRight restMarginTop restMaxHeight restMaxWidth restRowHeight

    Methods

    free rebind

    Constructors

    Accessors

    • get addSpacingAfterLastLine(): boolean

      Gets or sets a value indicating whether a line spacing should be added after the last line of the current Layout after splitting.

      Returns boolean

    • set addSpacingAfterLastLine(value: boolean): void

      Gets or sets a value indicating whether a line spacing should be added after the last line of the current Layout after splitting.

      Parameters

      • value: boolean

      Returns void

    • get allowMovingAllToRest(): boolean

      Gets or sets a value indicating whether, if no part of the content can fit in the current layout, to move all content to rest Layout.

      Returns boolean

    • set allowMovingAllToRest(value: boolean): void

      Gets or sets a value indicating whether, if no part of the content can fit in the current layout, to move all content to rest Layout.

      Parameters

      • value: boolean

      Returns void

    • get id(): number

      Gets the reference to the object.

      Returns number

    • get keepParagraphLinesTogether(): boolean

      Gets or sets a value indicating whether paragraphs should be kept together (cannot be split between pages or columns).

      Returns boolean

    • set keepParagraphLinesTogether(value: boolean): void

      Gets or sets a value indicating whether paragraphs should be kept together (cannot be split between pages or columns).

      Parameters

      • value: boolean

      Returns void

    • get lineGapBeforeFirstLine(): boolean

      Gets or sets a value indicating whether the typographic line gap should be added before the first line of the rest Layout.

      Returns boolean

    • set lineGapBeforeFirstLine(value: boolean): void

      Gets or sets a value indicating whether the typographic line gap should be added before the first line of the rest Layout.

      Parameters

      • value: boolean

      Returns void

    • get minLinesInFirstParagraph(): number

      Gets or sets the minimum number of lines on the last page (or at the ending of the first paragraph on the next page) to prevent widows.

      Returns number

    • set minLinesInFirstParagraph(value: number): void

      Gets or sets the minimum number of lines on the last page (or at the ending of the first paragraph on the next page) to prevent widows.

      Parameters

      • value: number

      Returns void

    • get minLinesInLastParagraph(): number

      Gets or sets the minimum number of lines that must appear at the beginning of the last paragraph to prevent orphans.

      Returns number

    • set minLinesInLastParagraph(value: number): void

      Gets or sets the minimum number of lines that must appear at the beginning of the last paragraph to prevent orphans.

      Parameters

      • value: number

      Returns void

    • get restColumnWidth(): number | null

      Gets or sets the width of the layout box measured from left or right margin for the rest of the text after splitting, in graphic units.

      Returns number | null

    • set restColumnWidth(value: number | null): void

      Gets or sets the width of the layout box measured from left or right margin for the rest of the text after splitting, in graphic units.

      Parameters

      • value: number | null

      Returns void

    • get restMarginBottom(): number

      Gets or sets the bottom margin of the layout box for the rest of the text after splitting, in graphic units.

      Returns number

    • set restMarginBottom(value: number): void

      Gets or sets the bottom margin of the layout box for the rest of the text after splitting, in graphic units.

      Parameters

      • value: number

      Returns void

    • get restMarginLeft(): number

      Gets or sets the left margin of the layout box for the rest of the text after splitting, in graphic units.

      Returns number

    • set restMarginLeft(value: number): void

      Gets or sets the left margin of the layout box for the rest of the text after splitting, in graphic units.

      Parameters

      • value: number

      Returns void

    • get restMarginRight(): number

      Gets or sets the right margin of the layout box for the rest of the text after splitting, in graphic units.

      Returns number

    • set restMarginRight(value: number): void

      Gets or sets the right margin of the layout box for the rest of the text after splitting, in graphic units.

      Parameters

      • value: number

      Returns void

    • get restMarginTop(): number

      Gets or sets the top margin of the layout box for the rest of the text after splitting, in graphic units.

      Returns number

    • set restMarginTop(value: number): void

      Gets or sets the top margin of the layout box for the rest of the text after splitting, in graphic units.

      Parameters

      • value: number

      Returns void

    • get restMaxHeight(): number | null

      Gets or sets the height of the layout box for the rest of the text after splitting, in graphic units.

      Returns number | null

    • set restMaxHeight(value: number | null): void

      Gets or sets the height of the layout box for the rest of the text after splitting, in graphic units.

      Parameters

      • value: number | null

      Returns void

    • get restMaxWidth(): number | null

      Gets or sets the width of the layout box for the rest of the text after splitting, in graphic units.

      Returns number | null

    • set restMaxWidth(value: number | null): void

      Gets or sets the width of the layout box for the rest of the text after splitting, in graphic units.

      Parameters

      • value: number | null

      Returns void

    • get restRowHeight(): number | null

      Gets or sets the height of the layout box measured from top or bottom margin for the rest of the text after splitting, in graphic units.

      Returns number | null

    • set restRowHeight(value: number | null): void

      Gets or sets the height of the layout box measured from top or bottom margin for the rest of the text after splitting, in graphic units.

      Parameters

      • value: number | null

      Returns void

    Methods

    • Detaches the object from the ObjectManager and deallocates its memory, if possible.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods