PDF Web SDK Documentation

Comprehensive Guide for Developers: UI & SDK Integration, Configuration, and API Reference

PDF Web SDK
    Preparing search index...

    Interface IOcrAdvancedConfig

    OCR Advanced settings, shown under Settings and reachable from the OCR pop-up's Settings icon.

    The set of options an OCR module actually supports depends on which one UM (User Management) grants for the current user - Iris (ocr) exposes all of these, ML OCR (ocr-tess) has no configurable settings beyond language. Use IOcrAdvancedConfig.available to show or hide the section and icon accordingly once your app knows which module is active.

    interface IOcrAdvancedConfig {
        available?: boolean;
        createBookmarks?: boolean;
        deskew?: boolean;
        detectTextOrientation?: boolean;
        embedFonts?: boolean;
        jpeg2000Compression?: boolean;
        jpeg2000CompressionQuality?: OcrCompressionQuality;
        language?: string;
        recognitionQuality?: OcrRecognitionQuality;
        recognizedTextOutput?: OcrRecognizedTextOutput;
        rotatePage?: boolean;
    }
    Index

    Properties

    available? createBookmarks? deskew? detectTextOrientation? embedFonts? jpeg2000Compression? jpeg2000CompressionQuality? language? recognitionQuality? recognizedTextOutput? rotatePage?

    Properties

    available?: boolean

    Whether the OCR Advanced section (Settings) and the OCR pop-up's Settings icon are shown. Flip this once your app knows which OCR module UM granted for the signed-in user (ocr → Iris → true; ocr-tess, or no module → false). Defaults to false.

    createBookmarks?: boolean

    Keep previously created bookmarks in the document after recognition. Defaults to false.

    deskew?: boolean

    Straightens a crooked image. Defaults to true.

    detectTextOrientation?: boolean

    Detects inverted text blocks. Defaults to true.

    embedFonts?: boolean

    Embed fonts not installed on the recognizing system. Defaults to false.

    jpeg2000Compression?: boolean

    Whether JPEG 2000 compression is applied. Defaults to true.

    jpeg2000CompressionQuality?: OcrCompressionQuality

    Defaults to 'high'.

    language?: string

    SupportedOcrLanguage code. Defaults to 'en'.

    recognitionQuality?: OcrRecognitionQuality

    Defaults to 'high'.

    recognizedTextOutput?: OcrRecognizedTextOutput

    Defaults to 'text-image'.

    rotatePage?: boolean

    Straightens a skewed image. Defaults to true.

    Settings

    Member Visibility

    On This Page

    Properties