Class TextPatternScannerResult

constructor

• new TextPatternScannerResult(
      source?: DeepPartial<TextPatternScannerResult>,
  ): TextPatternScannerResult

  Parameters

  • Optionalsource: DeepPartial<TextPatternScannerResult>

  Returns TextPatternScannerResult

Readonlyconfidence

ReadonlyrawText

ReadonlysymbolBoxes

ReadonlyvalidationSuccessful

ReadonlywordBoxes

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): {
      confidence?: number;
      rawText?: string;
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly rawText?: string | undefined; readonly wordBoxes?: { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; readonly symbolBoxes?: ...;
      symbolBoxes?: {
          boundingRect?: Rectangle;
          recognitionConfidence?: number;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly symbol?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          symbol?: string;
      }[];
      validationSuccessful?: boolean;
      wordBoxes?: {
          boundingRect?: Rectangle;
          recognitionConfidence?: number;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          text?: string;
      }[];
  }

  Parameters

  • Optionalconfig: ToJsonConfiguration

  Returns {
      confidence?: number;
      rawText?: string;
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly rawText?: string | undefined; readonly wordBoxes?: { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; readonly symbolBoxes?: ...;
      symbolBoxes?: {
          boundingRect?: Rectangle;
          recognitionConfidence?: number;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly symbol?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          symbol?: string;
      }[];
      validationSuccessful?: boolean;
      wordBoxes?: {
          boundingRect?: Rectangle;
          recognitionConfidence?: number;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          text?: string;
      }[];
  }

  • Optional Readonlyconfidence?: number

    Confidence of the recognition.

    Default is 0.0.

  • Optional ReadonlyrawText?: string

    Raw recognized string.

  • Optionalserialize?: (
        config?: ToJsonConfiguration,
    ) => { readonly rawText?: string | undefined; readonly wordBoxes?: { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; readonly symbolBoxes?: ...

  • Optional ReadonlysymbolBoxes?: {
        boundingRect?: Rectangle;
        recognitionConfidence?: number;
        serialize?: (
            config?: ToJsonConfiguration,
        ) => { readonly symbol?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
        symbol?: string;
    }[]

    Boxes for each recognized symbol.

  • Optional ReadonlyvalidationSuccessful?: boolean

    True if both the configured validator (if any) and the configured frame accumulation criteria were satisfied.

    Default is false.

  • Optional ReadonlywordBoxes?: {
        boundingRect?: Rectangle;
        recognitionConfidence?: number;
        serialize?: (
            config?: ToJsonConfiguration,
        ) => { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
        text?: string;
    }[]

    Boxes for each recognized word.