Class CroppingViewConfiguration

Hierarchy

  • BaseConfiguration
    • CroppingViewConfiguration

Constructors

constructor

Properties

container? containerId? disableScroll? image polygon? rotations? style?

Methods

fromJson mapValues mapValuesDeep

Constructors

constructor

Properties

Optional container

container?: HTMLElement

The container HTML element of Scanbot Web SDK camera. Required when 'containerId' property is left undefined when calling any ScanbotSDK createScanner function. If both are provided, 'container' property takes precedence.

Optional containerId

containerId?: string

The container HTML element id of Scanbot Web SDK camera. Required when 'container' property is left undefined when calling any ScanbotSDK createScanner function If both are provided, 'container' property takes precedence.

Optional disableScroll

disableScroll?: boolean

Determines whether scroll (incl. bounce) should be disabled when cropping screen is active. Enhances drag-to-crop experience. True by default

image

image: Image

Optional polygon

polygon?: Polygon

The polygon that defines the initial cropping area. All points should have relative coordinates between 0 and 1. If this is not set, the cropping area is initialized with an automatically detected outline of the document.

Optional rotations

rotations?: number

Initial rotations of the original image. Default is 0

Optional style

style?: CroppingViewStyle

Methods

Static fromJson

Static mapValues

  • mapValues(source, destination, ignore?): void

  • Parameters

    • source: any
    • destination: {
          [key: string]: any;
      }
      • [key: string]: any
    • Optional ignore: string[]

    Returns void

Static mapValuesDeep

  • mapValuesDeep(source, destination): void

  • Parameters

    • source: any
    • destination: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc