Class ViewFinderScannerConfiguration

Hierarchy

Constructors

constructor

Properties

backgroundColor? container? containerId? finder? mirrored? onError? preferredCamera? spinnerColor? userGuidance? videoConstraints? DEFAULT_ACCEPTED_ANGLE_SCORE DEFAULT_ACCEPTED_BRIGHTNESS_SCORE DEFAULT_ACCEPTED_SIZE_SCORE DEFAULT_VIDEO_RESOLUTION_4K DEFAULT_VIDEO_RESOLUTION_HD

Methods

mapFinderConfiguration mapValues mapValuesDeep

Constructors

constructor

Properties

Optional backgroundColor

backgroundColor?: string

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 finder

finder?: {
    aspectRatio?: { width?: number; height?: number; };
    overlayColor?: string;
    style?: ({ _type?: "FinderCorneredStyle"; strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) | ({ _type?: "FinderStrokedStyle"; strokeColor?: string; strokeWidth?: number; cornerRadius?: number; });
    visible?: boolean;
}

Type declaration

  • Optional aspectRatio?: { width?: number; height?: number; }

    The viewfinder's aspect ratio.

    Default Value

    new AspectRatio({
     "width": 1.0,
     "height": 1.0
     });
  • Optional overlayColor?: string

    Color of the viewfinder overlay.

    Default Value

    "?sbColorSurfaceLow";
  • Optional style?: ({ _type?: "FinderCorneredStyle"; strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) | ({ _type?: "FinderStrokedStyle"; strokeColor?: string; strokeWidth?: number; cornerRadius?: number; })

    Visual appearance of the viewfinder.

    Default Value

    new FinderCorneredStyle({
       "strokeColor": "?sbColorSurface",
       "strokeWidth": 2.0,
       "cornerRadius": 10.0
    });
  • Optional visible?: boolean

    Whether the viewfinder is visible.

    Default Value

    true;

Optional mirrored

mirrored?: boolean

Optional onError

onError?: ((e) => void)

Type declaration

    • (e): void

    • Error callback of the SDK.

      Parameters

      • e: any

      Returns void

Optional preferredCamera

preferredCamera?: string

Optional spinnerColor

spinnerColor?: string

Optional userGuidance

userGuidance?: {
    background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; };
    title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; };
    visible?: boolean;
}

Type declaration

  • Optional background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; }

    Background style used for the user guidance.

    Default Value

    new BackgroundStyle({
       "strokeColor": "#00000000",
       "fillColor": "?sbColorSurfaceLow"
    });
  • Optional title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }

    Title of the user guidance.

    Default Value

    new StyledText({
     "color": "?sbColorOnPrimary"
     });
  • Optional visible?: boolean

    Whether the user guidance is visible.

    Default Value

    true;

Optional videoConstraints

videoConstraints?: any

ScanbotCameraView video constraints

Static DEFAULT_ACCEPTED_ANGLE_SCORE

DEFAULT_ACCEPTED_ANGLE_SCORE: number

Static DEFAULT_ACCEPTED_BRIGHTNESS_SCORE

DEFAULT_ACCEPTED_BRIGHTNESS_SCORE: number

Static DEFAULT_ACCEPTED_SIZE_SCORE

DEFAULT_ACCEPTED_SIZE_SCORE: number

Static DEFAULT_VIDEO_RESOLUTION_4K

DEFAULT_VIDEO_RESOLUTION_4K: {
    height: number;
    width: number;
}

Type declaration

  • height: number
  • width: number

Static DEFAULT_VIDEO_RESOLUTION_HD

DEFAULT_VIDEO_RESOLUTION_HD: {
    height: number;
    width: number;
}

Type declaration

  • height: number
  • width: number

Methods

Static mapFinderConfiguration

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