Spotlight Viewfinder#

Defined under the namespace Scandit.Datacapture.Core.Ui

SpotlightViewfinder#
class SpotlightViewfinder : Viewfinder

Added in version 6.1.0

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

The spotlight viewfinder is always displayed but the color of the border around the spotlight changes depending on whether the data capture mode is enabled or 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 spotlight viewfinder with default parameters.

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.

enabledBorderColor#
enabledBorderColor: Color

Added in version 6.1.0

The color used to draw the spotlight border when the data capture mode is enabled.

disabledBorderColor#
disabledBorderColor: Color

Added in version 6.1.0

The color used to draw the spotlight border when the data capture mode is disabled.

backgroundColor#
backgroundColor: Color

Added in version 6.1.0

The color used to draw the darkened area surrounding the spotlight.