Interface SelectionOverlayConfig

The selection overlay configuration.

interface SelectionOverlayConfig {
    automaticSelectionEnabled?: boolean;
    highlightedPolygonColor?: ColorValue;
    highlightedStrokeColor?: ColorValue;
    highlightedTextColor?: ColorValue;
    highlightedTextContainerColor?: ColorValue;
    overlayEnabled?: boolean;
    polygonColor?: ColorValue;
    shouldHighlightBarcode?: ((barcodeItem) => boolean);
    strokeColor?: ColorValue;
    textColor?: ColorValue;
    textContainerColor?: ColorValue;
    textFormat?: BarcodeOverlayTextFormat;
}

Properties

automaticSelectionEnabled? highlightedPolygonColor? highlightedStrokeColor? highlightedTextColor? highlightedTextContainerColor? overlayEnabled? polygonColor? shouldHighlightBarcode? strokeColor? textColor? textContainerColor? textFormat?

Properties

Optional automaticSelectionEnabled

automaticSelectionEnabled?: boolean

Whether the barcode is highlighted automatically when being detected or not.

Optional highlightedPolygonColor

highlightedPolygonColor?: ColorValue

The color of the polygon in the selection overlay, when highlighted.

Optional highlightedStrokeColor

highlightedStrokeColor?: ColorValue

The color of the highlighted polygon border.

Optional highlightedTextColor

highlightedTextColor?: ColorValue

The color of the text in the selection overlay, when highlighted.

Optional highlightedTextContainerColor

highlightedTextContainerColor?: ColorValue

The color of the texts background in the selection overlay, when highlighted.

Optional overlayEnabled

overlayEnabled?: boolean

Whether the barcode selection overlay is enabled or not.

Optional polygonColor

polygonColor?: ColorValue

The color of the polygon in the selection overlay.

Optional shouldHighlightBarcode

shouldHighlightBarcode?: ((barcodeItem) => boolean)

Callback that determines which barcodes should be selected.

Type declaration

Optional strokeColor

strokeColor?: ColorValue

The color of the polygon border.

Optional textColor

textColor?: ColorValue

The color of the text in the selection overlay.

Optional textContainerColor

textContainerColor?: ColorValue

The color of the texts background in the selection overlay.

Optional textFormat

textFormat?: BarcodeOverlayTextFormat

Define the way of how to show barcode data with selection overlay.

Settings

Member Visibility

Theme

On This Page

automaticSelectionEnabledhighlightedPolygonColorhighlightedStrokeColorhighlightedTextColorhighlightedTextContainerColoroverlayEnabledpolygonColorshouldHighlightBarcodestrokeColortextColortextContainerColortextFormat