ExtractPDFOptionsBuilder

ExtractPDFOptionsBuilder

Builds a ExtractPdfOptions instance.

Methods

addElementsToExtract(…elements) → {ExtractPDFOptionsBuilder}

Description:
  • Sets the elements to extract - like text and/or tables.

Parameters:
Name Type Attributes Description
elements ExtractPdfOptions.ExtractElementType <repeatable>

List of Extract Element Type to be extracted

Returns:

This Builder instance to add any additional parameters.

Type
ExtractPDFOptionsBuilder

addElementsToExtractRenditions(…elements) → {ExtractPDFOptionsBuilder}

Description:
  • Sets the renditions to extract - like tables and/or figures.

Parameters:
Name Type Attributes Description
elements ExtractPdfOptions.ExtractRenditionsElementType <repeatable>

List of Renditions Element Type to be extracted

Returns:

This Builder instance to add any additional parameters.

Type
ExtractPDFOptionsBuilder

addCharInfo(element) → {ExtractPDFOptionsBuilder}

Description:
  • Boolean specifying whether to add character level bounding boxes to output json

Parameters:
Name Type Description
element Boolean

Set True to extract character level bounding boxes information

Returns:
  • This Builder instance to add any additional parameters.
Type
ExtractPDFOptionsBuilder

addTableStructureFormat(element)

Description:
  • Adds the table structure format (currently csv only) for extracting structured information.

Parameters:
Name Type Description
element ExtractPdfOptions.TableStructureType

TableStructureType to be extracted

Returns:

ExtractPdfOperation - current ExtractPdfOperation instance

getStylingInfo(element) → {ExtractPDFOptionsBuilder}

Description:
  • Boolean specifying whether to get styling info of text

Parameters:
Name Type Description
element Boolean

Set True to extract styling info of text

Returns:
  • This Builder instance to add any additional parameters.
Type
ExtractPDFOptionsBuilder

build() → {ExtractPdfOptions}

Description:
  • Returns a new ExtractPdfOptions instance built from the current state of this builder.

Returns:

A new ExtractPdfOptions instance.

Type
ExtractPdfOptions