Label Field Definition

Defined under the namespace Scandit.Datacapture.Label

LabelFieldDefinition

class LabelFieldDefinition

Added in version 8.0.0

Base class for defining fields within a label. Label field definitions specify the expected content, validation regexes, and constraints for individual data elements that make up a label structure.

Field definitions are used within LabelDefinition objects to describe the composition of labels, including what types of data to expect (barcodes, text, dates) and how to validate that data.

name

get name(): string

Added in version 8.0.0

The unique identifier for this field within the label definition. This name is used to reference the field when processing captured results and must be unique within the label definition.

valueRegexes

valueRegexes: string[]

Added in version 8.0.0

Regular expressions used to validate captured content. These regexes allow you to ensure that the captured data matches the expected format for your specific field type.

For example, you can use regexes like [“\d{2}/\d{2}/\d{4}”] for date formats, or [“[A-Z]{2}\d{6}”] for codes that must start with two letters followed by six digits.

hiddenProperties

hiddenProperties: object<string, object>

Added in version 8.0.0

Internal configuration properties used for advanced field customization. These properties are not part of the public API and are used internally by the SDK for field configuration.

optional

optional: boolean

Added in version 8.0.0

Determines whether this field is required for the label to be considered complete. When set to true, the label can be marked as complete even if this field is not found. When false (mandatory), the label will only be complete when this field is successfully captured.

Optional fields are useful for scenarios where certain information might not always be present on labels, such as promotional codes or secondary identifiers.