Class CroppingViewResult

constructor

• new CroppingViewResult(
      source: {
          polygon?: Point[];
          rotation?: ImageRotation;
          sourceImage?:
              | {
                  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<
                      {
                          buffer?: string;
                          clear?: () => Promise<(...)>;
                          encodeImage?: (options?: (...) | (...)) => Promise<(...)>;
                          encodeInPlace?: () => Promise<(...)>;
                          hibernate?: () => Promise<(...)>;
                          info?: () => Promise<(...)>;
                          isRetained?: () => boolean;
                          release?: () => void;
                          retain?: () => void;
                          saveImage?: (path: string, options?: (...) | (...)) => Promise<(...)>;
                          serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<{ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ... | undefined; ... 8 more ...; retain?: (() => void) | undefined; }>) | undefined;
                          uniqueId?: string;
                      },
                  >;
                  uniqueId?: string;
              } & {}
              | null;
      },
  ): CroppingViewResult

  Parameters

  • source: {
        polygon?: Point[];
        rotation?: ImageRotation;
        sourceImage?:
            | {
                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<
                    {
                        buffer?: string;
                        clear?: () => Promise<(...)>;
                        encodeImage?: (options?: (...) | (...)) => Promise<(...)>;
                        encodeInPlace?: () => Promise<(...)>;
                        hibernate?: () => Promise<(...)>;
                        info?: () => Promise<(...)>;
                        isRetained?: () => boolean;
                        release?: () => void;
                        retain?: () => void;
                        saveImage?: (path: string, options?: (...) | (...)) => Promise<(...)>;
                        serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<{ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ... | undefined; ... 8 more ...; retain?: (() => void) | undefined; }>) | undefined;
                        uniqueId?: string;
                    },
                >;
                uniqueId?: string;
            } & {}
            | null;
    }

    • Optional Readonlypolygon?: Point[]

      The polygon of the cropped area.

    • Optional Readonlyrotation?: ImageRotation

      The rotation of the resulting cropped area

    • Optional ReadonlysourceImage?:
          | {
              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<
                  {
                      buffer?: string;
                      clear?: () => Promise<(...)>;
                      encodeImage?: (options?: (...) | (...)) => Promise<(...)>;
                      encodeInPlace?: () => Promise<(...)>;
                      hibernate?: () => Promise<(...)>;
                      info?: () => Promise<(...)>;
                      isRetained?: () => boolean;
                      release?: () => void;
                      retain?: () => void;
                      saveImage?: (path: string, options?: (...) | (...)) => Promise<(...)>;
                      serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<{ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ... | undefined; ... 8 more ...; retain?: (() => void) | undefined; }>) | undefined;
                      uniqueId?: string;
                  },
              >;
              uniqueId?: string;
          } & {}
          | null

      A crop from the input image.

  Returns CroppingViewResult

Readonlypolygon

Readonlyrotation

ReadonlysourceImage