Note

This API is still in beta and may change in future versions of Scandit Data Capture SDK.

Barcode Definition

Defined under the namespace Scandit.Datacapture.Barcode

BarcodeDefinition
class BarcodeDefinition : ScanComponentDefinition<BarcodeIdentifier>

Added in version 8.1.0

A class that holds the definition for a barcode expected to be scanned as part of a certain ScanItemDefinition.

constructor(identifier, symbologies)
constructor(identifier: BarcodeIdentifier,
        symbologies: Set<Symbology>)

Added in version 8.1.0

A constructor that receives the identifier and symbologies for the barcode definition.

identifier
get identifier(): BarcodeIdentifier

Added in version 8.1.0

The unique identifier for this component.

location
location: Quadrilateral | null

Added in version 8.1.0

The expected location of the barcode.

optional
optional: boolean

Added in version 8.1.0

Whether the barcode is optional.

symbologies
get symbologies(): Set<Symbology>

Added in version 8.1.0

The list of symbologies that the barcode could be using.

preset
preset: ScanComponentBarcodePreset | null

Added in version 8.1.0

A preset to be applied to the barcode definition.

hiddenProperties
hiddenProperties: string | null

Added in version 8.1.0

A list of hidden properties to set on the barcode definition.

valueRegexes
valueRegexes: string[]

Added in version 8.1.0

A list of value regexes to use when searching for the barcode.

anchorRegexes
anchorRegexes: string[]

Added in version 8.1.0

A list of anchor regexes to use when searching for the barcode.

builder(identifier)
static builder(identifier: BarcodeIdentifier): BarcodeDefinitionBuilder

Added in version 8.1.0

Creates a builder object that can be used to fluently create a BarcodeDefinition instance.