# SplitOptions ## Content # Class: SplitOptions Represents the options for text splitting. ## Extends - [`ObjectBase`](ObjectBase) ## Constructors ### Constructor ```ts new SplitOptions(properties?): SplitOptions; ``` Creates a new SplitOptions object with specified properties. #### Parameters ##### properties? [`SplitOptionsProperties`](../type-aliases/SplitOptionsProperties) The options for text splitting. #### Returns `SplitOptions` #### Overrides ```ts ObjectBase.constructor ``` ### Constructor ```ts new SplitOptions(baseLayout, properties?): SplitOptions; ``` Creates a new SplitOptions based on properties of an existing [Layout](Layout). #### Parameters ##### baseLayout [`Layout`](Layout) The Layout object used as the base for the new SplitOptions. ##### properties? [`SplitOptionsProperties`](../type-aliases/SplitOptionsProperties) The settings overriding properties of the base Layout. #### Returns `SplitOptions` #### Overrides ```ts ObjectBase.constructor ``` ### Constructor ```ts new SplitOptions(baseSplitOptions, properties?): SplitOptions; ``` Creates a new SplitOptions based on properties of an existing SplitOptions. #### Parameters ##### baseSplitOptions `SplitOptions` The SplitOptions object used as the base for the new SplitOptions. ##### properties? [`SplitOptionsProperties`](../type-aliases/SplitOptionsProperties) The settings overriding properties of the base SplitOptions. #### Returns `SplitOptions` #### Overrides ```ts ObjectBase.constructor ``` ### Constructor ```ts new SplitOptions(om, properties?): SplitOptions; ``` Creates a new SplitOptions object with specified properties. #### Parameters ##### om [`ObjectManager`](ObjectManager) An object manager that controls the lifetime of the SplitOptions object. ##### properties? [`SplitOptionsProperties`](../type-aliases/SplitOptionsProperties) The options for text splitting. #### Returns `SplitOptions` #### Overrides ```ts ObjectBase.constructor ``` ## Accessors ### addSpacingAfterLastLine #### Get Signature ```ts 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 Signature ```ts set addSpacingAfterLastLine(value): 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` *** ### allowMovingAllToRest #### Get Signature ```ts 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 Signature ```ts set allowMovingAllToRest(value): 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` *** ### id #### Get Signature ```ts get id(): number; ``` Gets the reference to the object. ##### Returns `number` #### Inherited from [`ObjectBase`](ObjectBase).[`id`](ObjectBase#id) *** ### keepParagraphLinesTogether #### Get Signature ```ts 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 Signature ```ts set keepParagraphLinesTogether(value): 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` *** ### lineGapBeforeFirstLine #### Get Signature ```ts 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 Signature ```ts set lineGapBeforeFirstLine(value): 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` *** ### minLinesInFirstParagraph #### Get Signature ```ts 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 Signature ```ts set minLinesInFirstParagraph(value): 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` *** ### minLinesInLastParagraph #### Get Signature ```ts 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 Signature ```ts set minLinesInLastParagraph(value): 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` *** ### om #### Get Signature ```ts get om(): ObjectManager; ``` Gets the owner [ObjectManager](ObjectManager) instance. ##### Returns [`ObjectManager`](ObjectManager) #### Inherited from [`ObjectBase`](ObjectBase).[`om`](ObjectBase#om) *** ### restColumnWidth #### Get Signature ```ts get restColumnWidth(): number; ``` 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` #### Set Signature ```ts set restColumnWidth(value): 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` ##### Returns `void` *** ### restMarginBottom #### Get Signature ```ts 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 Signature ```ts set restMarginBottom(value): 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` *** ### restMarginLeft #### Get Signature ```ts 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 Signature ```ts set restMarginLeft(value): 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` *** ### restMarginRight #### Get Signature ```ts 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 Signature ```ts set restMarginRight(value): 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` *** ### restMarginTop #### Get Signature ```ts 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 Signature ```ts set restMarginTop(value): 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` *** ### restMaxHeight #### Get Signature ```ts get restMaxHeight(): number; ``` Gets or sets the height of the layout box for the rest of the text after splitting, in graphic units. ##### Returns `number` #### Set Signature ```ts set restMaxHeight(value): void; ``` Gets or sets the height of the layout box for the rest of the text after splitting, in graphic units. ##### Parameters ###### value `number` ##### Returns `void` *** ### restMaxWidth #### Get Signature ```ts get restMaxWidth(): number; ``` Gets or sets the width of the layout box for the rest of the text after splitting, in graphic units. ##### Returns `number` #### Set Signature ```ts set restMaxWidth(value): void; ``` Gets or sets the width of the layout box for the rest of the text after splitting, in graphic units. ##### Parameters ###### value `number` ##### Returns `void` *** ### restRowHeight #### Get Signature ```ts get restRowHeight(): number; ``` 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` #### Set Signature ```ts set restRowHeight(value): 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` ##### Returns `void` ## Methods ### free() ```ts free(): void; ``` Detaches the object from the [ObjectManager](ObjectManager) and deallocates its memory, if possible. #### Returns `void` #### Inherited from [`ObjectBase`](ObjectBase).[`free`](ObjectBase#free) *** ### rebind() ```ts rebind(omTo): void; ``` Rebinds the object from the current [ObjectManager](ObjectManager) to the specified one. #### Parameters ##### omTo [`ObjectManager`](ObjectManager) The new [ObjectManager](ObjectManager) for the object. #### Returns `void` #### Inherited from [`ObjectBase`](ObjectBase).[`rebind`](ObjectBase#rebind)