JSONExtractor Properties
Free Trial Web API version Licensing Request A Quote
HAVE QUESTIONS OR NEED HELP?SUBMIT THE SUPPORT REQUEST FORM or write email toSUPPORT@BYTESCOUT.COM
The JSONExtractor type exposes the following members.
Properties
Name | Description | |
---|---|---|
AllowStandalonePunctuation | Gets or sets whether to allow standalone punctuation characters. If false they will be merged with nearest text object. | |
AutoAlignColumnsToHeader | Sets whether to align text in the columns to the header. (Inherited from BaseTextExtractor.) | |
CheckPermissions | Defines whether to respect permissions set by document owner. If True, extractor throws exception when the extraction is prohibited. IMPORTANT: THIS OPTION HAVE TO BE ENABLED AND SET TO "TRUE" TO RESPECT OWNERS OF PDF DOCUMENTS. IF YOU SET IT TO FALSE TO IGNORE PERMISSIONS WHICH ARE SET IN PDF DOCUMENT THEN YOU ARE SOLELY LIABLE FOR THIS ACTION AND ANY COPYRIGHT OR OTHER VIOLATIONS AT YOUR OWN RISK. BYTESCOUT IS NOT LIABLE FOR ANY DAMAGES, LOSSES, COPYRIGHT INFRINGEMENTS OR ANY OTHER CONSEQUENCES CAUSED BY IGNORING PERMISSIONS OF PDF DOCUMENT. BY CHANGING THIS OPTION YOU ARE CONFIRMING YOU ARE UNDERSTANDING ALL WRITTEN ABOVE AND DOING IT AT YOUR OWN RISK. (Inherited from BaseExtractor.) | |
CleanJSON | Get or sets whether to generate regular JSON with camel-cased object identifiers without '@' (attribute) and '#' (node content) marks. Default is true. | |
ColumnDetectionByTextAlignment | Suggests the extractor the visual text alignment in table cells. It helps to detect columns when tables don't have vertical separating lines between columns and the columns are formed by text alignment. (Inherited from BaseTextExtractor.) | |
ColumnDetectionMode | Sets how columns are detected. Default is 'ContentGroupsAndBorders' - columns are detected by grouping of text objects and by vertical vector lines. (Inherited from BaseTextExtractor.) | |
ComHelpers | Set of utility functions and properties to use from COM/ActiveX. (Inherited from BaseExtractor.) | |
ConsiderBackgroundColors | Consider background colors under text objects when detecting table structure. It can be useful for striped tables, but may degrade extraction quality on scanned documents because of uneven image background. Default is false. (Inherited from BaseTextExtractor.) | |
ConsiderFontColors | Consider font colors in document text when detecting table structure. Default is false. (Inherited from BaseTextExtractor.) | |
ConsiderFontNames | Consider font names in document text when detecting table structure. Default is false. (Inherited from BaseTextExtractor.) | |
ConsiderFontSizes | Consider font sizes in document text when detecting table structure. Default is false. (Inherited from BaseTextExtractor.) | |
ConsiderHorizontalBorders | Consider horizontal borders between text objects when detecting table structure and merging objects. Default is true. (Inherited from BaseTextExtractor.) | |
ConsiderVerticalBorders | Consider vertical borders between text objects when detecting table structure and merging objects. Default is true. (Inherited from BaseTextExtractor.) | |
ContentType | Returns content type of PDF document: normal document, portfolio or XFA form. To extract files from PDF portfolio use AttachmentExtractor class. To extract XFA form content use XFAFormExtractor class. (Inherited from BaseExtractor.) | |
CustomExtractionColumns | Allows to override automatic columns detection with custom columns coordinates. (Inherited from BaseTextExtractor.) | |
DetectLinesInsteadOfParagraphs | Obsolete. Lines detection option. Obsolete: Use LineGroupingMode instead. (Inherited from BaseTextExtractor.) | |
DetectNewColumnBySpacesRatio | Space ratio between words. Large spacing is treated as column separator. Using this parameter you can control the column detection. (Inherited from BaseTextExtractor.) | |
DetectStrikeoutTextStyle | Get or sets whether to detect the "strikeout" text style. Default is false. | |
DetectUnderlineTextStyle | Get or sets whether to detect the "underline" text style. Default is false. | |
EmbeddedFileCount | Obsolete. Property is disabled to speed up the document loading. Use AttachmentExtractor to work with attachments. (Inherited from BaseExtractor.) | |
EnableTextAnalysis | Enables or disables extracted text analysis. Check TextAnalysisResults after the extraction for analysis results. (Inherited from BaseTextExtractor.) | |
Encrypted | Gets whether the document is encrypted. (Inherited from BaseExtractor.) | |
ExtractAnnotations | Sets whether to extract text from annotation objects. Default is true. (Inherited from BaseTextExtractor.) | |
ExtractColumnByColumn | Sets whether we should reconstruct table structure or extract text objects as they go in the PDF document stream. Default is true. (Inherited from BaseTextExtractor.) | |
ExtractInvisibleText | Sets whether to extract invisible text from a PDF document. (Inherited from BaseTextExtractor.) | |
ExtractionArea | Sets the extraction area by coordinates and dimensions (left, top, width, height). (Inherited from BaseExtractor.) | |
ExtractionAreaRect | Sets the extraction area by rectangle. (Inherited from BaseExtractor.) | |
ExtractionAreaUsageMode | Gets or sets how to use the ExtractionArea: whether to extract any object intersecting with the area or only objects completely located inside the area. (Inherited from BaseExtractor.) | |
ExtractionColumns | Contains columns detected from last processed document page. (Inherited from BaseTextExtractor.) | |
ExtractShadowLikeText | Sets whether to extract shadow-like text from a PDF document (when the same text is drawn twice with small offset). Default is 'true' - includes all decoded text, regardless of its appearance. (Inherited from BaseTextExtractor.) | |
ImageFolder | Gets or sets the folder to put extracted images when SaveImages property is set to ImageHandling.OuterFile. Default is "images" - the extractor will create "images" sub-folder in the same folder with output JSON file. | |
ImageFormat | Gets or sets the image format for extracted images. Default is PNG. | |
IndentedJSON | Get or sets whether to generate indented JSON. Default is true. | |
IsDocumentLoaded | Get the document loaded state. (Inherited from BaseExtractor.) | |
KeepOriginalFontNames | By default JSONExtractor replaces names of embedded fonts with standard (or "descendant") fonts similar by metrics and typeface. This is because embedded fonts differ from fonts installed into your system or absent there at all. Set this property to true if you want to keep the original font names. | |
LicenseInfo | Gets license information. (Inherited from BaseExtractor.) | |
LineGroupingMode | Sets how lines are grouped into paragraphs. Default is None (no line grouping is performed). (Inherited from BaseTextExtractor.) | |
NormalizeText | Set whether the extracted text should be normalized. Default is false. (Inherited from BaseTextExtractor.) | |
OCRAutoModeMinExistingTextLength | Applies to OCRMode.Auto only. Sets the minimal total length of normal text objects on the current page to decide whether to perform OCR or not. If the length of the text is less than this value then extractor will use OCR for this page. Otherwise it extracts the existing normal text objects only. (Inherited from BaseTextExtractor.) | |
OCRBlackList | A set of characters not allowed to be recognized from scanned document. The resulting text will only contain characters that are not in this list. This helps improve uncertain recognition. (Inherited from BaseTextExtractor.) | |
OCRCacheMode | Sets caching of OCR results. Default is Off (no caching). In WholePage caching mode you can save processing time as the SDK will check if need to re-run OCR on the page or it can just pull results from previously cached OCR results. (Inherited from BaseTextExtractor.) | |
OCRCorrections | A set of corrections automatically applied to recognized text to fix repeating recognition errors. (Inherited from BaseTextExtractor.) | |
OCRDetectLines | Sets whether to detect horizontal and vertical lines during OCR. They help to detect the table structure in scanned documents. Default is false. (Inherited from BaseTextExtractor.) | |
OCRDetectPageRotation | Sets whether to detect scanned page rotation. Slightly slows down the processing. (Inherited from BaseTextExtractor.) | |
OCRDisableAutoSegmentation | Sets whether to disable the automatic segmentation. All pages will be treated as containing sparse text (as a typical document such as an invoice). (Inherited from BaseTextExtractor.) | |
OCRImagePreprocessingFilters | A set of corrections automatically applied to recognized text to fix repeating recognition errors. (Inherited from BaseTextExtractor.) | |
OCRLanguage | Language of OCR (Optical Character Recognition). The valid values are: (Inherited from BaseTextExtractor.)
Download more languages at https://github.com/bytescout/ocrdata. | |
OCRLanguageDataFolder | Folder containing OCR language data files. (Inherited from BaseTextExtractor.) | |
OCRMaximizeCPUUtilization | Gets or sets maximum OCR performance using Intel OpenMP (if available) to accelerate to approximately 30%. Default is false. (Inherited from BaseTextExtractor.) | |
OCRMode | Enables use of the OCR (Optical Character Recognition) which allows you to recognize text from images embedded in PDF pages. Set the language using the OCRLanguage property. (Inherited from BaseTextExtractor.)This option requires Bytescout.PDFExtractor.OCRExtension.dll assembly reference and relevant language files in OCRLanguageDataFolder folder. The SDK is shipped with language files for English, French, German and Spanish. You can download more languages at https://github.com/bytescout/ocrdata. | |
OCROverallConfidence | Gets overall OCR confidence. This value is calculated after the extraction is performed. (Inherited from BaseTextExtractor.) | |
OCRPageCount | Gets count of processed pages for which OCR was performed. This value is calculated after the extraction is finished. (Inherited from BaseTextExtractor.) | |
OCRResolution | Resolution of OCR (Optical Character Recognition). Default is 300 DPI. (Inherited from BaseTextExtractor.) | |
OCRWhiteList | A set of characters allowed to be recognized from scanned document. Only characters from this list will appear in the result text. This helps improve uncertain recognition. (Inherited from BaseTextExtractor.) | |
OutputStructure | Gets or sets the structure of output JSON data. | |
OutputTransformation | Gets or sets JSONPath ("XPath for JSON") expression that you can use to transform the output JSON. | |
PageDataCaching | Controls page data caching behavior. (Inherited from BaseExtractor.) | |
Password | PDF document password. (Inherited from BaseExtractor.) | |
PreserveFormattingOnTextExtraction | Sets whether to preserve the text formatting on the extraction. (Inherited from BaseTextExtractor.) | |
Profiles | Comma-separated list of profiles to apply to the extractor. Profiles must be previously loaded. (Inherited from BaseExtractor.) | |
RegistrationKey | Registration key. (Inherited from BaseExtractor.) | |
RegistrationName | Registration name. (Inherited from BaseExtractor.) | |
RemoveHyphenation | Sets whether to automatically remove hyphenations in end of lines (works when is true). (Inherited from BaseTextExtractor.) | |
RotationAngle | Sets whether to rotate document pages to specified angle before the extraction. (Inherited from BaseTextExtractor.) | |
RTLTextAutoDetectionEnabled | Enables RTL (Right-To-Left) text auto detection. Default is true. (Inherited from BaseTextExtractor.) | |
SaveImages | Get or sets the image saving way: do not save; save to outer file; embed into result JSON as Base64 string. Default is ImageHandling.None. | |
SaveVectors | Get or sets whether to save vector objects. Default is false. | |
ShrinkMultipleSpaces | Replaces multiple spaces in text objects with a single space. Multiple spaces affect column detection, so removing them may improve the result. Default is false. (Inherited from BaseTextExtractor.) | |
TableXMinIntersectionRequiredInPercents | During the reconstruction of table structure, sets how much of the cell rectangle should intersect (by X coordinate axis) with the previous cell to treat both cells belong to the same row. (Inherited from BaseTextExtractor.) | |
TableYMinIntersectionRequiredInPercents | During the reconstruction of table structure, sets how much of the cell rectangle should intersect (by Y coordinate axis) with the previous cell to treat both cells belong to the same column. (Inherited from BaseTextExtractor.) | |
TextAnalysisCorruptedTextThreshold | The criterion of detection of the corrupted text used in text analysis. Default is 0.5. (Inherited from BaseTextExtractor.) | |
TextAnalysisResults | Results of the text analysis. Enable the analysis using EnableTextAnalysis property. (Inherited from BaseTextExtractor.) | |
TextEncodingCodePage | Sets the default text encoding. Default encoding is "iso-8859-1". (Inherited from BaseTextExtractor.) | |
TrimSpaces | Sets whether to remove trailing and ending spaces from the text of table cells. Default is true. (Inherited from BaseTextExtractor.) | |
Unwrap | Sets whether to unwrap the contents of a multiline table cell into a single line. Default is true. (Inherited from BaseTextExtractor.) | |
Version | Gets the component version number. (Inherited from BaseExtractor.) | |
XCoordinateToleranceFactor | Sets X coordinate tolerance to use when constructing table structure of PDF page. (Inherited from BaseTextExtractor.) | |
YCoordinateToleranceFactor | Sets Y coordinate tolerance to use when constructing table structure of PDF page. (Inherited from BaseTextExtractor.) |
See Also