Class Field

constructor

• new Field(source?): Field

• Parameters

  • Optional source: DeepPartial<Field>

  Returns Field

Readonly confidenceWeight

Readonly image

Readonly parsedData

Readonly polygonInRoot

Readonly type

Readonly validationStatus

Readonly value

encodeImages

• encodeImages(): Promise<void>

• Returns Promise<void>

release

• release(): void

• Returns void

serialize

• serialize(config?): Promise<{
      confidenceWeight?: number;
      image?: null | {
          buffer: undefined | string;
          uniqueId?: string;
          clear?(): Promise<void>;
          encodeImage?(options?): Promise<null | string>;
          encodeInPlace?(): Promise<void>;
          hibernate?(): Promise<void>;
          info?(): Promise<null | ImageInfo>;
          isRetained?(): boolean;
          release?(): void;
          retain?(): void;
          saveImage?(path, options?): Promise<boolean>;
          serialize?(imageSerializationMode): Promise<null | ({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<(... & {}) | null>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {})>;
      } & {};
      parsedData?: {
          type?: FieldDataFormat;
          value?: string;
          serialize?(config?): { readonly type?: FieldDataFormat | undefined; readonly value?: string | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      }[];
      polygonInRoot?: Point[];
      type?: {
          commonType?: null | CommonFieldType;
          fullName?: string;
          listIndex?: null | number;
          name?: string;
          normalizedName?: string;
          serialize?(config?): { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly commonType?: CommonFieldType | null | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      };
      validationStatus?: FieldValidationStatus;
      value?: null | {
          confidence?: number;
          text?: string;
          serialize?(config?): {
              confidence?: number;
              text?: string;
              serialize?(config?): { readonly text?: string | undefined; readonly confidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          };
      } & {};
      encodeImages?(): Promise<void>;
      release?(): void;
      serialize?(config?): Promise<{ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly commonType?: CommonFieldType | null | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefi...;
  }>

• Parameters

  • Optional config: ToJsonConfiguration

  Returns Promise<{
      confidenceWeight?: number;
      image?: null | {
          buffer: undefined | string;
          uniqueId?: string;
          clear?(): Promise<void>;
          encodeImage?(options?): Promise<null | string>;
          encodeInPlace?(): Promise<void>;
          hibernate?(): Promise<void>;
          info?(): Promise<null | ImageInfo>;
          isRetained?(): boolean;
          release?(): void;
          retain?(): void;
          saveImage?(path, options?): Promise<boolean>;
          serialize?(imageSerializationMode): Promise<null | ({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<(... & {}) | null>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {})>;
      } & {};
      parsedData?: {
          type?: FieldDataFormat;
          value?: string;
          serialize?(config?): { readonly type?: FieldDataFormat | undefined; readonly value?: string | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      }[];
      polygonInRoot?: Point[];
      type?: {
          commonType?: null | CommonFieldType;
          fullName?: string;
          listIndex?: null | number;
          name?: string;
          normalizedName?: string;
          serialize?(config?): { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly commonType?: CommonFieldType | null | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      };
      validationStatus?: FieldValidationStatus;
      value?: null | {
          confidence?: number;
          text?: string;
          serialize?(config?): {
              confidence?: number;
              text?: string;
              serialize?(config?): { readonly text?: string | undefined; readonly confidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          };
      } & {};
      encodeImages?(): Promise<void>;
      release?(): void;
      serialize?(config?): Promise<{ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly commonType?: CommonFieldType | null | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefi...;
  }>