- README
- globals
- classes
- enumerations
- functions
-
type-aliases
- ActionGoToProperties
- ActionGoToRProperties
- ActionJavaScriptProperties
- ActionNamedProperties
- ActionProperties
- ActionResetFormProperties
- ActionSubmitFormProperties
- ActionURIProperties
- AlphaBlendOptions
- AnnotationBaseProperties
- AnnotationProperties
- AnnotationReferenceType
- ArcSegmentProperties
- BilevelBitmapProperties
- BitBltOptions
- BmpContextProperties
- BorderEffectProperties
- BorderProperties
- Bounds
- ButtonAppearanceProperties
- CaretAnnotationProperties
- CheckBoxFieldProperties
- ChoiceFieldItemProperties
- ChoiceFieldProperties
- CircleAnnotationProperties
- Color
- ComboBoxFieldProperties
- CombTextFieldProperties
- CompositeAndBlendOptions
- DefaultAppearanceProperties
- DestinationFitBHProperties
- DestinationFitBProperties
- DestinationFitBVProperties
- DestinationFitHProperties
- DestinationFitProperties
- DestinationFitRProperties
- DestinationFitVProperties
- DestinationProperties
- DestinationPropertiesBase
- DestinationRefProperties
- DestinationXYZProperties
- DocActionProperties
- DocDestination
- DocDestinationProperties
- DocumentInfoProperties
- DrawEllipseOptions
- DrawImageOptions
- DrawPathOptions
- DrawPdfPageOptions
- DrawPolygonOptions
- DrawRectangleOptions
- EmbeddedFileStreamProperties
- EncryptOptions
- ExportFormDataOptions
- FieldBaseProperties
- FieldProperties
- FileAttachmentAnnotationIcon
- FileAttachmentAnnotationProperties
- FileID
- FileSpecificationProperties
- FileSpecProperties
- FindTextParams
- FontFeature
- FormatProperties
- FoundPosition
- FreeTextAnnotationProperties
- GlyphRun
- GradientStop
- GrayscaleBitmapProperties
- HatchBrushProperties
- ImageOptions
- ImageOrBitmap
- ImageScaleProperties
- InkAnnotationProperties
- LayoutProperties
- LineAnnotationProperties
- LinearGradientBrushProperties
- LinkAnnotationProperties
- ListBoxFieldProperties
- MarkupAnnotationProperties
- MergeDocumentOptions
- MetadataProperties
- MetadataUserProp
- Offsets
- OutlineNodeProperties
- OutputRange
- PdfDateTime
- PdfDecryptionOptions
- PdfDocumentOptions
- PdfPageContextOptions
- PenProperties
- PermissionOptions
- Point
- PolygonAnnotationBaseProperties
- PolygonAnnotationProperties
- PolyLineAnnotationProperties
- PopupAnnotationProperties
- PushButtonFieldProperties
- Quadrilateral
- RadialGradientBrushProperties
- RadioButtonFieldProperties
- Rect
- RedactAnnotationProperties
- RedactOptions
- ResizeBitmapOptions
- RichMediaAnnotationProperties
- RunProperties
- SaveAsImageOptions
- SavePdfOptions
- SaveSvgOptions
- SearchFontOptions
- SignatureFieldProperties
- SignatureLockedFieldsProperties
- Size
- SoundAnnotationIcon
- SoundAnnotationProperties
- SoundObjectProperties
- SplitOptionsProperties
- SquareAnnotationProperties
- StampAnnotationProperties
- SvgAttribute
- SvgContextProperties
- TabStop
- TextAnnotationIcon
- TextAnnotationProperties
- TextFieldBaseProperties
- TextFieldProperties
- TextLine
- TextLineFragment
- TextMapFragment
- TextMarkupAnnotationProperties
- WatermarkAnnotationProperties
- WidgetAnnotationProperties
- WidgetProperties
SplitOptionsProperties
DsPdfJS API / SplitOptionsProperties
Type Alias: SplitOptionsProperties
SplitOptionsProperties =
object
Provides options for text splitting.
Properties
addSpacingAfterLastLine?
optionaladdSpacingAfterLastLine: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?
optionalallowMovingAllToRest: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?
optionalbaseLayout:Layout|null
A reference to the Layout object to copy the initial data from.
baseSplitOptions?
optionalbaseSplitOptions: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?
optionalkeepParagraphLinesTogether: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?
optionallineGapBeforeFirstLine: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?
optionalminLinesInFirstParagraph: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?
optionalminLinesInLastParagraph: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?
optionalrestColumnWidth: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?
optionalrestMarginBottom: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?
optionalrestMarginLeft: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?
optionalrestMarginRight: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?
optionalrestMarginTop: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?
optionalrestMaxHeight: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?
optionalrestMaxWidth: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?
optionalrestRowHeight: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.