Parameters for extract PDF operation using ExtractPDFJob.

Implements

Constructors

  • Construct a new ExtractPDFParams instance.

    Parameters

    • params: {
          addCharInfo?: boolean;
          elementsToExtract?: ExtractElementType[];
          elementsToExtractRenditions?: ExtractRenditionsElementType[];
          getStylingInfo?: boolean;
          tableStructureType?: TableStructureType;
      }

      The parameters for constructing an instance of ExtractPDFParams.

      • Optional addCharInfo?: boolean

        Whether to add character level bounding boxes to output json. Default value is false.

      • Optional elementsToExtract?: ExtractElementType[]

        List of elements that should be extracted as JSON. Default value is TEXT.

      • Optional elementsToExtractRenditions?: ExtractRenditionsElementType[]

        List of elements whose renditions should be generated.

      • Optional getStylingInfo?: boolean

        Whether to add styling information to output JSON. Default value is false.

      • Optional tableStructureType?: TableStructureType

        The TableStructureType for output type of table structure. Default value is XLSX.

    Returns ExtractPDFParams

Properties

_addCharInfo?: boolean
_elementsToExtract?: ExtractElementType[]
_elementsToExtractRenditions?: ExtractRenditionsElementType[]
_getStylingInfo?: boolean
_tableStructureType?: TableStructureType

Accessors

  • get addCharInfo(): undefined | boolean
  • Returns true if character information is to be added to the resulting JSON.

    Returns undefined | boolean

    true if character information is to be added to the resulting JSON.

  • get elementsToExtract(): undefined | ExtractElementType[]
  • Returns the elements to extract.

    Returns undefined | ExtractElementType[]

    the elements to extract.

  • get getStylingInfo(): undefined | boolean
  • Returns true if styling information is to be added to the resulting JSON.

    Returns undefined | boolean

    true if styling information is to be added to the resulting JSON.

  • get tableStructureType(): undefined | TableStructureType
  • Returns the table structure type.

    Returns undefined | TableStructureType

    the table structure type.

Generated using TypeDoc