Class TextPatternScanner

API for text pattern scanning.

Required licence feature(s): TextPatternScanner.

Methods

cleanRecognitionQueue destroy run create

Methods

cleanRecognitionQueue

  • cleanRecognitionQueue(): Promise<void>

  • Clean the queue of recognize text lines.@returns

    Returns Promise<void>

destroy

  • destroy(): Promise<void>

  • Frees up any resources associated with this object. No other methods may be called on this object after destroy has been called.

    Returns Promise<void>

run

Static create

  • create(workerBridge, configuration?): Promise<TextPatternScanner>

  • Parameters

    • workerBridge: WorkerBridge
    • Optional configuration: {
          maximumNumberOfAccumulatedFrames?: number;
          minimumNumberOfRequiredFramesWithEqualScanningResult?: number;
          ocrResolutionLimit?: number;
          optimizeSingleLine?: boolean;
          validator?: {
              allowedCharacters?: string;
          } & {
              _type: "DefaultContentValidator";
          } | {
              allowedCharacters?: string;
              matchSubstring?: boolean;
              pattern?: string;
              patternGrammar?: PatternGrammar;
          } & {
              _type: "PatternContentValidator";
          };
      }
      • Optional maximumNumberOfAccumulatedFrames?: number

        Maximum number of accumulated frames to inspect before actual result is returned.

        Default Value

        3;
      • Optional minimumNumberOfRequiredFramesWithEqualScanningResult?: number

        Minimum number of accumulated frames that have equal result.

        Default Value

        2;
      • Optional ocrResolutionLimit?: number

        Maximum image size (height or width) for OCR process. 0 - do not rescale.

        Default Value

        0;
      • Optional optimizeSingleLine?: boolean

        Optimize for scanning a single line or a single word. Enable this option when scanning a single line or single word that are hard to scan reliably.

        Default Value

        false;
      • Optional validator?: {
            allowedCharacters?: string;
        } & {
            _type: "DefaultContentValidator";
        } | {
            allowedCharacters?: string;
            matchSubstring?: boolean;
            pattern?: string;
            patternGrammar?: PatternGrammar;
        } & {
            _type: "PatternContentValidator";
        }

        Content validator.

        Default Value

        new DefaultContentValidator({});

    Returns Promise<TextPatternScanner>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc