Note
This API is still in beta and may change in future versions of Scandit Data Capture SDK.
Text Definition
Defined under the namespace Scandit.Datacapture.Barcode
- TextDefinition
class TextDefinition : ScanComponentDefinition<TextIdentifier>
Added in version 8.1.0
A class that holds the definition for a text expected to be scanned as part of a certain ScanItemDefinition.
- constructor(identifier)
constructor(identifier: TextIdentifier)
Added in version 8.1.0
A constructor that receives the identifier for the text definition.
- identifier
get identifier(): TextIdentifier
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 text.
- semantics
semantics: ScanComponentTextSemanticType | null
Added in version 8.1.0
A semantic type to be applied to the text definition.
- hiddenProperties
hiddenProperties: string
Added in version 8.1.0
A list of hidden properties to set on the text definition.
- valueRegexes
valueRegexes: string[]
Added in version 8.1.0
A list of value regex to use when searching for the text.
- anchorRegexes
anchorRegexes: string[]
Added in version 8.1.0
A list of anchor regexes to use when searching for the text.
- builder(identifier)
static builder(identifier: TextIdentifier): TextDefinitionBuilder
Added in version 8.1.0
Creates a builder object that can be used to fluently create a TextDefinition instance.