Interface FinderConfig

Configuration properties of the finder overlay

interface FinderConfig {
    finderInset?: FinderInset;
    finderLineColor?: string;
    finderLineWidth?: number;
    minPadding?: number;
    overlayColor?: string;
    requiredAspectRatio?: AspectRatio;
    viewFinderEnabled?: boolean;
}

Properties

finderInset? finderLineColor? finderLineWidth? minPadding? overlayColor? requiredAspectRatio? viewFinderEnabled?

Properties

Optional finderInset

finderInset?: FinderInset

The minimum space from view finders outer edges to the view edges.

Optional finderLineColor

finderLineColor?: string

Color of finder frame border.

Optional finderLineWidth

finderLineWidth?: number

Width of finder frame border.

Optional minPadding

minPadding?: number

Initial padding for insets. Android only.

Optional overlayColor

overlayColor?: string

Background color of the detection overlay.

Optional requiredAspectRatio

requiredAspectRatio?: AspectRatio

Aspect ratio of finder frame (width \ height), which is used to build actual finder frame.

Optional viewFinderEnabled

viewFinderEnabled?: boolean

Display the region of interest. The default value is TRUE.

Settings

Member Visibility

Theme

On This Page

finderInsetfinderLineColorfinderLineWidthminPaddingoverlayColorrequiredAspectRatioviewFinderEnabled