Class Field

constructor

• new Field(source?: DeepPartial<Field>): Field

  Parameters

  • Optionalsource: DeepPartial<Field>

  Returns Field

ReadonlyconfidenceWeight

Readonlyimage

ReadonlyparsedData

ReadonlypolygonInRoot

Readonlytype

ReadonlyvalidationStatus

Readonlyvalue

encodeImages

• encodeImages(): Promise<void>

  Returns Promise<void>

release

• release(): void

  Returns void

serialize

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

  Parameters

  • Optionalconfig: ToJsonConfiguration

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