Class Word

constructor

• new Word(source?): Word

• Parameters

  • Optional source: DeepPartial<Word>

  Returns Word

Readonly _type

Readonly confidence

Readonly glyphs

Readonly roi

Readonly text

serialize

• serialize(config?): {
      _type?: "Word";
      confidence?: number;
      glyphs?: {
          _type?: "Glyph";
          confidence?: number;
          roi?: Point[];
          text?: string;
          serialize?(config?): { readonly _type?: "Glyph" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      }[];
      roi?: Point[];
      text?: string;
      serialize?(config?): { 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...;
  }

• Parameters

  • Optional config: ToJsonConfiguration

  Returns {
      _type?: "Word";
      confidence?: number;
      glyphs?: {
          _type?: "Glyph";
          confidence?: number;
          roi?: Point[];
          text?: string;
          serialize?(config?): { readonly _type?: "Glyph" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      }[];
      roi?: Point[];
      text?: string;
      serialize?(config?): { 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 Readonly _type?: "Word"

  • Optional Readonly confidence?: number

    Text confidence. Range is [0-1].

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

    List of glyphs.

  • Optional Readonly roi?: Point[]

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

  • Optional Readonly text?: string

    The recognized text.

  • serialize?:function

    • serialize(config?): { 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...

    • Parameters

      • Optional config: ToJsonConfiguration

      Returns { 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...