Configuration of the Find and Pick barcode scanning mode.

Hierarchy

  • PartiallyConstructible
    • FindAndPickScanningMode

Constructors

Properties

_type: "FindAndPickScanningMode"
allowPartialScan: boolean

If the user is allowed to finish the scanning process without scanning all the expected barcodes.

Default Value

false;

Configuration of the AR overlay.

Default Value

new ArOverlayFindAndPickConfiguration({
"visible": true,
"automaticSelectionEnabled": true,
"polygon": new FindAndPickArOverlayPolygonConfiguration({
"partiallyScanned": new PolygonStyle({
"strokeColor": "?sbColorWarning",
"fillColor": "#00000000",
"strokeWidth": 3.0,
"cornerRadius": 5.0
}),
"rejected": new PolygonStyle({
"strokeColor": "?sbColorSurface",
"fillColor": "#00000000",
"strokeWidth": 3.0,
"cornerRadius": 5.0
}),
"completed": new PolygonStyle({
"strokeColor": "?sbColorPositive",
"fillColor": "#00000000",
"strokeWidth": 3.0,
"cornerRadius": 5.0
})
}),
"badge": new FindAndPickBadgeConfiguration({
"partiallyScanned": new BadgeStyle({
"visible": true,
"background": new BackgroundStyle({
"strokeColor": "#000000FF",
"fillColor": "?sbColorWarning",
"strokeWidth": 0.0
}),
"foregroundColor": "?sbColorOnSurface"
}),
"rejected": new BadgeStyle({
"visible": true,
"background": new BackgroundStyle({
"strokeColor": "#000000FF",
"fillColor": "?sbColorSurface",
"strokeWidth": 0.0
}),
"foregroundColor": "?sbColorOnSurface"
}),
"completed": new BadgeStyle({
"visible": true,
"background": new BackgroundStyle({
"strokeColor": "#000000FF",
"fillColor": "?sbColorPositive",
"strokeWidth": 0.0
}),
"foregroundColor": "?sbColorOnSurface"
})
})
});
confirmationAlertDialog: ScanbotAlertDialog

Configuration of the confirmation alert dialog.

Default Value

new ScanbotAlertDialog({
"title": new StyledText({
"text": "?findAndPickCompleteAlertTitle",
"color": "?sbColorOnSurface"
}),
"subtitle": new StyledText({
"text": "?findAndPickCompleteAlertSubtitle",
"color": "?sbColorOnSurfaceVariant"
}),
"sheetColor": "?sbColorSurface",
"modalOverlayColor": "?sbColorModalOverlay",
"dividerColor": "?sbColorOutline",
"okButton": new ButtonConfiguration({
"visible": true,
"text": "?findAndPickCompleteAlertSubmitButton",
"background": new BackgroundStyle({
"strokeColor": "?sbColorPrimary",
"fillColor": "?sbColorPrimary",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": true,
"color": "?sbColorOnPrimary",
"useShadow": false
})
}),
"cancelButton": new ButtonConfiguration({
"visible": true,
"text": "?findAndPickCompleteAlertCancelButton",
"background": new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "#00000000",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": false,
"color": "?sbColorPrimary",
"useShadow": false
})
})
});
confirmationAlertDialogEnabled: boolean

If the confirmation alert dialog is enabled.

Default Value

false;
countingRepeatDelay: number

Time interval in milliseconds before a barcode is counted again. 0 = no delay. The default value is 1000.

Default Value

1000;
expectedBarcodes: ExpectedBarcode[]

List of barcodes that the user has to find and scan.

Default Value

[];
manualCountEditDialog: ManualCountEditDialog

Configuration of the dialog to manually edit the barcode count.

Default Value

new ManualCountEditDialog({
"sheetColor": "?sbColorSurface",
"dividerColor": "?sbColorOutline",
"modalOverlayColor": "?sbColorModalOverlay",
"title": new StyledText({
"text": "?manualCountEditDialogTitle",
"color": "?sbColorOnSurface"
}),
"info": new StyledText({
"text": "?manualCountEditDialogInfo",
"color": "?sbColorOnSurfaceVariant"
}),
"updateButton": new ButtonConfiguration({
"visible": true,
"text": "?manualCountEditDialogUpdateButton",
"background": new BackgroundStyle({
"strokeColor": "?sbColorPrimary",
"fillColor": "?sbColorPrimary",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": false,
"color": "?sbColorOnPrimary",
"useShadow": false
})
}),
"cancelButton": new ButtonConfiguration({
"visible": true,
"text": "?manualCountEditDialogCancelButton",
"background": new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "#00000000",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": false,
"color": "?sbColorPrimary",
"useShadow": false
})
}),
"clearTextButton": new IconStyle({
"visible": true,
"color": "?sbColorOnSurfaceVariant"
})
});
partialScannedAlertDialog: ScanbotAlertDialog

Configuration of the partial scanned alert dialog.

Default Value

new ScanbotAlertDialog({
"title": new StyledText({
"text": "?findAndPickPartialAlertTitle",
"color": "?sbColorOnSurface"
}),
"subtitle": new StyledText({
"text": "?findAndPickPartialAlertSubtitle",
"color": "?sbColorOnSurfaceVariant"
}),
"sheetColor": "?sbColorSurface",
"modalOverlayColor": "?sbColorModalOverlay",
"dividerColor": "?sbColorOutline",
"okButton": new ButtonConfiguration({
"visible": true,
"text": "?findAndPickPartialAlertSubmitButton",
"background": new BackgroundStyle({
"strokeColor": "?sbColorPrimary",
"fillColor": "?sbColorPrimary",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": true,
"color": "?sbColorOnPrimary",
"useShadow": false
})
}),
"cancelButton": new ButtonConfiguration({
"visible": true,
"text": "?findAndPickPartialAlertCancelButton",
"background": new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "#00000000",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": false,
"color": "?sbColorPrimary",
"useShadow": false
})
})
});
partialScannedAlertDialogEnabled: boolean

If the partial scanned alert dialog is enabled.

Default Value

true;
scanningCompletedColor: string

Color of the selected barcode.

Default Value

"?sbColorPositive";
scanningNotScannedColor: string

Color of the not scanned barcode .

Default Value

"?sbColorOutline";
scanningPartiallyColor: string

Color of the partially scanned barcode.

Default Value

"?sbColorWarning";
sheet: Sheet

Configuration of the preview mode for the barcodes required to be found and scanned.

Default Value

new Sheet({
"mode": "COLLAPSED_SHEET",
"collapsedVisibleHeight": "SMALL",
"listButton": new BadgedButton({
"badgeBackgroundColor": "?sbColorSurface",
"badgeForegroundColor": "?sbColorPrimary",
"visible": true,
"backgroundColor": "?sbColorSurfaceHigh",
"foregroundColor": "?sbColorOnPrimary",
"activeBackgroundColor": "?sbColorSurfaceHigh",
"activeForegroundColor": "?sbColorOnPrimary"
})
});
sheetContent: SheetContent

Configuration of the list of barcodes required to be found and scanned.

Default Value

new SheetContent({
"sheetColor": "?sbColorSurface",
"dividerColor": "?sbColorOutline",
"manualCountChangeEnabled": true,
"manualCountOutlineColor": "?sbColorOutline",
"manualCountChangeColor": "?sbColorPrimary",
"title": new StyledText({
"visible": true,
"text": "?findAndPickSheetTitle",
"color": "?sbColorOnSurface",
"useShadow": false
}),
"clearAllButton": new ButtonConfiguration({
"visible": true,
"text": "?sheetResetButton",
"background": new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "#00000000",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": false,
"color": "?sbColorOnSurface",
"useShadow": false
})
}),
"barcodeItemTitle": new StyledText({
"text": "BARCODE_TITLE",
"color": "?sbColorOnSurface"
}),
"barcodeItemSubtitle": new StyledText({
"text": "?findAndPickSheetBarcodeItemSubtitle",
"color": "?sbColorOnSurfaceVariant"
}),
"barcodeItemImageVisible": true,
"submitButton": new ButtonConfiguration({
"visible": true,
"text": "?sheetSubmitButton",
"background": new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "#00000000",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": false,
"color": "?sbColorOnSurface",
"useShadow": false
})
}),
"startScanningButton": new ButtonConfiguration({
"visible": true,
"text": "?sheetStartScanningButton",
"background": new BackgroundStyle({
"strokeColor": "?sbColorPrimary",
"fillColor": "?sbColorPrimary",
"strokeWidth": 1.0
}),
"foreground": new ForegroundStyle({
"iconVisible": false,
"color": "?sbColorOnPrimary",
"useShadow": false
})
}),
"placeholderTitle": new StyledText({
"text": "?sheetPlaceholderTitle",
"color": "?sbColorOnSurface"
}),
"placeholderSubtitle": new StyledText({
"text": "?sheetPlaceholderSubtitle",
"color": "?sbColorOnSurfaceVariant"
}),
"placeholderIconBackground": "?sbColorOutline",
"placeholderIcon": new IconStyle({
"visible": true,
"color": "?sbColorOnSurface"
}),
"swipeToDelete": new SwipeToDelete({
"enabled": false,
"backgroundColor": "?sbColorNegative",
"iconColor": "?sbColorOnPrimary"
})
});

Generated using TypeDoc