Class ArOverlayGeneralConfiguration

Configuration of the AR overlay displayed on top of barcodes in the camera preview.

Hierarchy

  • PartiallyConstructible
    • ArOverlayGeneralConfiguration

Constructors

Properties

automaticSelectionEnabled: boolean

If enabled, the scanner will always immediately scan a barcode in the viewfinder or the camera view. The overlay will mark the scanned barcodes and stays above them.

Default Value

false;
barcodeItemConfiguration: BarcodeItemConfiguration

Configuration of the barcode info box displayed in the camera preview.

Default Value

new BarcodeItemConfiguration({
"imageVisible": true,
"titleSelected": new StyledText({
"text": "BARCODE_TITLE",
"color": "?sbColorOnSurface"
}),
"subtitleSelected": new StyledText({
"text": "BARCODE_SUBTITLE",
"color": "?sbColorOnSurfaceVariant"
}),
"titleDeselected": new StyledText({
"text": "BARCODE_TITLE",
"color": "?sbColorOnSurface"
}),
"subtitleDeselected": new StyledText({
"text": "BARCODE_SUBTITLE",
"color": "?sbColorOnSurfaceVariant"
}),
"backgroundSelected": new PolygonStyle({
"strokeColor": "?sbColorPositive",
"fillColor": "?sbColorPositive",
"strokeWidth": 1.0,
"cornerRadius": 5.0
}),
"backgroundDeselected": new PolygonStyle({
"strokeColor": "?sbColorSurface",
"fillColor": "?sbColorSurface",
"strokeWidth": 1.0,
"cornerRadius": 5.0
})
});
barcodeItemInfoPosition: BarcodeItemInfoPosition

Where to display the barcode info box in the camera preview.

Default Value

"BELOW";
counterBadge: BadgeStyle

Parameters of the counter badge appearance e.g. color of background its stroke and text/icon color.

Default Value

new BadgeStyle({
"background": new BackgroundStyle({}),
"foregroundColor": "?sbColorOnSurface"
});

Configuration of the overlay polygon displayed on top of a barcode in the camera preview.

Default Value

new ArOverlayPolygonConfiguration({
"visible": true,
"deselected": new PolygonStyle({}),
"selected": new PolygonStyle({})
});
visible: boolean

Control the visibility of the user guidance.

Default Value

false;

Generated using TypeDoc