capacitor-plugin-scanbot-sdk
    Preparing search index...

    Class Word

    Represents a single word. A word is made up of glyphs.

    Index

    Constructors

    Properties

    Methods

    Constructors

    • Parameters

      • Optionalsource: DeepPartial<Word>

      Returns Word

    Properties

    _type: "Word"
    confidence: number

    Text confidence. Range is [0-1].

    glyphs: Glyph[]

    List of glyphs.

    roi: Point[]

    Quad where the text was found in image coordinates. The order of the points is clockwise starting from the top left.

    text: string

    The recognized text.

    Methods

    • Parameters

      Returns {
          _type?: "Word";
          confidence?: number;
          glyphs?: {
              _type?: "Glyph";
              confidence?: number;
              roi?: Point[];
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly _type?: "Glyph" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              text?: string;
          }[];
          roi?: Point[];
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly _type?: "Word" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly glyphs?: { readonly _type?: "Glyph" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | und...;
          text?: string;
      }

      • Optional Readonly_type?: "Word"
      • Optional Readonlyconfidence?: number

        Text confidence. Range is [0-1].

      • Optional Readonlyglyphs?: {
            _type?: "Glyph";
            confidence?: number;
            roi?: Point[];
            serialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly _type?: "Glyph" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            text?: string;
        }[]

        List of glyphs.

      • Optional Readonlyroi?: Point[]

        Quad where the text was found in image coordinates. The order of the points is clockwise starting from the top left.

      • Optionalserialize?: (
            config?: ToJsonConfiguration,
        ) => { readonly _type?: "Word" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly glyphs?: { readonly _type?: "Glyph" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | und...
      • Optional Readonlytext?: string

        The recognized text.