Rectangular Viewfinder#

Defined under the namespace Scandit.Datacapture.Core.Ui

RectangularViewfinder#
class RectangularViewfinder : Viewfinder

Added in version 6.1.0

Rectangular viewfinder with an embedded Scandit logo. The rectangle is always centered on the point of interest of the view.

The rectangular viewfinder is displayed when the recognition is active and hidden when it is not.

To use this viewfinder, create a new instance and assign it to the overlay, e.g. the barcode capture overlay by assigning to the BarcodeCaptureOverlay.viewfinder property.

constructor()#
constructor()

Added in version 6.1.0

Returns a new rectangular viewfinder with default parameters.

color#
color: Color

Added in version 6.1.0

The color used to draw the logo and viewfinder when the mode is enabled. The color is always used at full opacity, changing the alpha value has no effect.

sizeWithUnitAndAspect#
get sizeWithUnitAndAspect(): SizeWithUnitAndAspect

Added in version 6.1.0

The size and sizing mode of the viewfinder.

setSize(size)#
setSize(size: SizeWithUnit): void

Added in version 6.1.0

Sets the horizontal and vertical size of the viewfinder to the provided value. When the unit is relative (unit in either x or y is MeasureUnit.Fraction) the size is computed relative to the view size minus the scan area margins.

setWidthAndAspectRatio(width, heightToWidthAspectRatio)#
setWidthAndAspectRatio(width: NumberWithUnit,
        heightToWidthAspectRatio: number): void

Added in version 6.1.0

Sets the width of the viewfinder and compute height automatically based on the provided height/width aspect ratio. When the unit is relative (MeasureUnit.Fraction), the width is computed relative to the view size minus the scan area margins.

setHeightAndAspectRatio(height, widthToHeightAspectRatio)#
setHeightAndAspectRatio(height: NumberWithUnit,
        widthToHeightAspectRatio: number): void

Added in version 6.1.0

Sets the height of the viewfinder and compute width automatically based on the provided width/height aspect ratio. When the unit is relative (MeasureUnit.Fraction), the height is computed relative to the view size minus the scan area margins.