Configuration of the single barcode scanning mode.

Hierarchy

  • PartiallyConstructible
    • SingleScanningMode

Constructors

Properties

_type: "SingleScanningMode"

Configuration of the AR overlay.

Default Value

new ArOverlayGeneralConfiguration({
"visible": false,
"counterBadge": new BadgeStyle({
"visible": true,
"background": new BackgroundStyle({
"strokeColor": "#000000FF",
"fillColor": "?sbColorPositive",
"strokeWidth": 0.0
}),
"foregroundColor": "?sbColorOnSurface"
}),
"automaticSelectionEnabled": false,
"barcodeItemInfoPosition": "BELOW",
"polygon": new ArOverlayPolygonConfiguration({
"visible": true,
"deselected": new PolygonStyle({
"strokeColor": "?sbColorSurface",
"fillColor": "#00000000",
"strokeWidth": 3.0,
"cornerRadius": 5.0
}),
"selected": new PolygonStyle({
"strokeColor": "?sbColorPositive",
"fillColor": "#00000000",
"strokeWidth": 3.0,
"cornerRadius": 5.0
})
}),
"barcodeItemConfiguration": 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({
"visible": true,
"text": "BARCODE_SUBTITLE",
"color": "?sbColorOnSurfaceVariant",
"useShadow": false
}),
"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
})
})
});
barcodeImageVisible: boolean

If enabled, the barcode image will be shown on the confirmation sheet.

Default Value

true;
barcodeInfoMapping: BarcodeInfoMapping

Appearance of the barcode info mapping.

Default Value

new BarcodeInfoMapping({
"sheetColor": "?sbColorSurface",
"dividerColor": "?sbColorOutline",
"modalOverlayColor": "?sbColorModalOverlay",
"loadingMessage": new StyledText({
"text": "?barcodeInfoMappingLoadingMessage",
"color": "?sbColorPrimary"
}),
"errorState": new BarcodeItemErrorState({
"title": new StyledText({
"text": "?barcodeInfoMappingErrorStateTitle",
"color": "?sbColorOnSurface"
}),
"subtitle": new StyledText({
"text": "?barcodeInfoMappingErrorStateSubtitle",
"color": "?sbColorOnSurfaceVariant"
}),
"retryButton": new ButtonConfiguration({
"visible": true,
"text": "?barcodeInfoMappingErrorStateRetryButton",
"background": new BackgroundStyle({
"strokeColor": "?sbColorPrimary",
"fillColor": "?sbColorPrimary",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": true,
"color": "?sbColorOnPrimary"
})
}),
"cancelButton": new ButtonConfiguration({
"text": "?barcodeInfoMappingErrorStateCancelButton",
"background": new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "#00000000",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": false,
"color": "?sbColorPrimary"
})
})
})
});
barcodeSubtitle: StyledText

Appearance of the barcode subtitle (the barcode's symbology) on the confirmation sheet.

Default Value

new StyledText({
"text": "BARCODE_SUBTITLE",
"color": "?sbColorOnSurfaceVariant"
});
barcodeTitle: StyledText

Appearance of the barcode title (the barcode's value) on the confirmation sheet.

Default Value

new StyledText({
"text": "BARCODE_TITLE",
"color": "?sbColorOnSurface"
});
cancelButton: ButtonConfiguration

Appearance of the cancel button on the confirmation sheet.

Default Value

new ButtonConfiguration({
"visible": true,
"text": "?singleModeConfirmationCancelButton",
"background": new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "#00000000",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": false,
"color": "?sbColorPrimary"
})
});
confirmationSheetEnabled: boolean

If enabled, the confirmation sheet will be shown after the barcode has been scanned.

Default Value

false;
dividerColor: string

Color of the divider and separator lines in the confirmation sheet.

Default Value

"?sbColorOutline";
modalOverlayColor: string

Background color of the overlay surrounding the confirmation sheet.

Default Value

"?sbColorModalOverlay";
sheetColor: string

Color of the confirmation sheet's background.

Default Value

"?sbColorSurface";
submitButton: ButtonConfiguration

Appearance of the confirm button on the confirmation sheet.

Default Value

new ButtonConfiguration({
"visible": true,
"text": "?sheetSubmitButton",
"background": new BackgroundStyle({
"strokeColor": "?sbColorPrimary",
"fillColor": "?sbColorPrimary",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": true,
"color": "?sbColorOnPrimary"
})
});

Generated using TypeDoc