Interface OverlayConfiguration

Corner radius in pixels for rectangular elements such as viewfinder and camera selector.

The allowed range of the corner radius is 0 to 8 pixels.

The size (in CSS pixels) used to render the custom logo.

Example:

configuration.overlay.customLogoSize = { width: 80, height: 20 };
Copy

When providing a custom logo in a raster image format such as PNG, JPEG or WEBP, the image will be scaled to fit the specified dimensions. In this case, it's recommended to provide a high-resolution (2x or 3x) raster image.

Override the STRICH logo displayed in the bottom-right corner with a custom image.

This capability is only available for Enterprise licenses. Please note that attempting to hide or replace the STRICH logo by other means is a violation of the License Agreement.

The image should ideally be supplied in SVG format, either inline as a data URL or as an absolute HTTPS URL.

The image will be rendered at its intrinsic size (pixel size = CSS size), which can lead to blurriness on high-density screens if the image is not supplied in SVG format.

Setting the property to null will display no logo at all.

Color to use for drawing a border around the area of detected barcodes. Must be specified in rgb() format, with the color components given as integers with no separating whitespace. The border will become transparent when the detection becomes stale.

The border width in pixels to use for drawing a border around the area of detected barcodes.

Color to use for filling area of detected barcodes. Must be specified in rgb() format, with the color components given as integers with no separating whitespace. The fill will become transparent when the detection becomes stale.

Filter cameras returned by the browser.

If set to true, only cameras that are deemed appropriate for barcode scanning will be offered in the camera selector.

Indicate if single-tapping the overlay should attempt to trigger autofocus.

Color to use for de-emphasizing the area around the viewfinder.

The color will be used to create a mask around the viewfinder/region of interest to aid the user in focusing the camera on the barcode.

A semi-translucent dark color works best, e.g. rgba(0,0,0,0.5) would use a semi-translucent black.

Color to use for drawing UI elements such as the viewfinder and camera selector. Must be specified in rgb() format, with the color components given as integers with no separating whitespace.

Indicate if the camera selector should be shown in the overlay.

Indicate if the overlay should draw the bounding boxes of detected barcodes on top of the camera preview.

Indicate if the flashlight toggle should be shown in the overlay.

Indicate if a horizontal line should be drawn to aid in positioning 1D barcodes.

Indicate if the zoom control should be shown in the overlay.

Color to use for drawing the horizontal targeting line when a barcode was detected. Must be specified in rgb() format, with the color components given as integers with no separating whitespace.

Border width in pixels of the viewfinder, the rectangle around the region of interest.

Corner radius in pixels of the viewfinder, the rectangle around the region of interest.

This property applies only to the viewfinder and overrides the OverlayConfiguration.cornerRadius property.

The allowed range of the corner radius is 0 to 20 pixels.

Indicate if double-tapping the overlay should cause the camera to zoom in.