Class DocumentStraighteningParameters

constructor

• new DocumentStraighteningParameters(
      source?: DeepPartial<DocumentStraighteningParameters>,
  ): DocumentStraighteningParameters

  Parameters

  • Optionalsource: DeepPartial<DocumentStraighteningParameters>

  Returns DocumentStraighteningParameters

aspectRatios

straighteningMode

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): {
      aspectRatios?: {
          height?: number;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly width?: number | undefined; readonly height?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          width?: number;
      }[];
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { straighteningMode?: DocumentStraighteningMode | undefined; aspectRatios?: { readonly width?: number | undefined; readonly height?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | unde...;
      straighteningMode?: DocumentStraighteningMode;
  }

  Parameters

  • Optionalconfig: ToJsonConfiguration

  Returns {
      aspectRatios?: {
          height?: number;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly width?: number | undefined; readonly height?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          width?: number;
      }[];
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { straighteningMode?: DocumentStraighteningMode | undefined; aspectRatios?: { readonly width?: number | undefined; readonly height?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | unde...;
      straighteningMode?: DocumentStraighteningMode;
  }

  • OptionalaspectRatios?: {
        height?: number;
        serialize?: (
            config?: ToJsonConfiguration,
        ) => { readonly width?: number | undefined; readonly height?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
        width?: number;
    }[]

    By default, aspect ratio of the straightened document is automatically determined based on the detected document corners. If the document is significantly deformed, the estimated aspect ratio may be inaccurate. In such cases, providing a list of expected aspect ratios may help improve the accuracy of the straightening. The closest matching aspect ratio from the list will be used. Note, that if for a given paper format you want to support both portrait and landscape orientations, you need to provide both aspect ratios (e.g. 1:√2 and √2:1 for A series papers).

  • Optionalserialize?: (
        config?: ToJsonConfiguration,
    ) => { straighteningMode?: DocumentStraighteningMode | undefined; aspectRatios?: { readonly width?: number | undefined; readonly height?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | unde...

  • OptionalstraighteningMode?: DocumentStraighteningMode

    Type of document straightening to apply.

    Default is STRAIGHTEN