Class CroppingViewResult

constructor

• new CroppingViewResult(source): CroppingViewResult

• Parameters

  • source: {
        polygon?: Point[];
        rotation?: ImageRotation;
        sourceImage?: 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; } & {})>;
        } & {};
    }

    • Optional Readonly polygon?: Point[]

      The polygon of the cropped area.

    • Optional Readonly rotation?: ImageRotation

      The rotation of the resulting cropped area

    • Optional Readonly sourceImage?: 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; } & {})>;
      } & {}

      A crop from the input image.

  Returns CroppingViewResult

Readonly polygon

Readonly rotation

Readonly sourceImage