Interface SelectionOverlayConfig

The selection overlay configuration.

interface SelectionOverlayConfig {
    automaticSelectionEnabled?: boolean;
    barcodeItemOverlayViewBinder?: ((barcodeItem) => BarcodeItemOverlayViewConfig | Promise<BarcodeItemOverlayViewConfig>);
    loadingTextValue?: string;
    overlayEnabled?: boolean;
    polygonColor?: ColorValue;
    strokeColor?: ColorValue;
    textColor?: ColorValue;
    textContainerColor?: ColorValue;
    textFormat?: BarcodeOverlayTextFormat;
}

Properties

automaticSelectionEnabled? barcodeItemOverlayViewBinder? loadingTextValue? overlayEnabled? polygonColor? strokeColor? textColor? textContainerColor? textFormat?

Properties

Optional automaticSelectionEnabled

automaticSelectionEnabled?: boolean

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

Optional barcodeItemOverlayViewBinder

barcodeItemOverlayViewBinder?: ((barcodeItem) => BarcodeItemOverlayViewConfig | Promise<BarcodeItemOverlayViewConfig>)

Callback that configures the selection overlay for each barcode item individually.

Type declaration

Optional loadingTextValue

loadingTextValue?: string

Only used if the barcodeItemOverlayViewBinder callback is set.

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 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

automaticSelectionEnabledbarcodeItemOverlayViewBinderloadingTextValueoverlayEnabledpolygonColorstrokeColortextColortextContainerColortextFormat