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

    Type Alias SplitOptionsProperties

    Provides options for text splitting.

    type SplitOptionsProperties = {
        addSpacingAfterLastLine?: boolean;
        allowMovingAllToRest?: boolean;
        baseLayout?: Layout | null;
        baseSplitOptions?: SplitOptions | null;
        keepParagraphLinesTogether?: boolean;
        lineGapBeforeFirstLine?: boolean;
        minLinesInFirstParagraph?: number;
        minLinesInLastParagraph?: number;
        restColumnWidth?: number | null;
        restMarginBottom?: number;
        restMarginLeft?: number;
        restMarginRight?: number;
        restMarginTop?: number;
        restMaxHeight?: number | null;
        restMaxWidth?: number | null;
        restRowHeight?: number | null;
    }
    Index

    Properties

    addSpacingAfterLastLine? allowMovingAllToRest? baseLayout? baseSplitOptions? keepParagraphLinesTogether? lineGapBeforeFirstLine? minLinesInFirstParagraph? minLinesInLastParagraph? restColumnWidth? restMarginBottom? restMarginLeft? restMarginRight? restMarginTop? restMaxHeight? restMaxWidth? restRowHeight?

    Properties

    addSpacingAfterLastLine?: boolean

    Indicates whether a line spacing should be added after the last line of the current Layout after splitting. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    allowMovingAllToRest?: boolean

    Indicates whether, if no part of the content can fit in the current Layout, to move all content to the rest Layout. The default is false. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    baseLayout?: Layout | null

    A reference to the Layout object to copy the initial data from.

    baseSplitOptions?: SplitOptions | null

    A reference to the SplitOptions object to copy the initial data from. If the SplitOptionsProperties.baseLayout is assigned, this property is ignored.

    keepParagraphLinesTogether?: boolean

    Indicates whether paragraphs should be kept together (cannot be split between pages or columns). Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    lineGapBeforeFirstLine?: boolean

    Indicates whether the typographic line gap should be added before the first line of the rest Layout. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    minLinesInFirstParagraph?: number

    The minimum number of lines on the last page (or at the ending of the first paragraph on the next page) to prevent widows. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    minLinesInLastParagraph?: number

    The minimum number of lines that must appear at the beginning of the last paragraph to prevent orphans. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    restColumnWidth?: number | null

    The width of the layout box measured from left or right margin for the rest of the text after splitting, in graphic units. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    restMarginBottom?: number

    The bottom margin of the layout box for the rest of the text after splitting, in graphic units. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    restMarginLeft?: number

    The left margin of the layout box for the rest of the text after splitting, in graphic units. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    restMarginRight?: number

    The right margin of the layout box for the rest of the text after splitting, in graphic units. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    restMarginTop?: number

    The top margin of the layout box for the rest of the text after splitting, in graphic units. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    restMaxHeight?: number | null

    The height of the layout box for the rest of the text after splitting, in graphic units. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    restMaxWidth?: number | null

    The width of the layout box for the rest of the text after splitting, in graphic units. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    restRowHeight?: number | null

    The height of the layout box measured from top or bottom margin for the rest of the text after splitting, in graphic units. Overrides the existing value if either SplitOptionsProperties.baseLayout or SplitOptionsProperties.baseSplitOptions are specified.

    Settings

    Member Visibility

    On This Page

    Properties