Note
This API is still in beta and may change in future versions of Scandit Data Capture SDK.
Text Definition
Defined in package com.scandit.datacapture.usi.capture.component.text
- TextDefinition
class TextDefinition : ScanComponentDefinition
Added in version 8.0.0
A class that holds the definition for a text expected to be scanned as part of a certain ScanItemDefinition.
- TextDefinition()
TextDefinition(identifier: TextIdentifier)
Added in version 8.0.0
A constructor that receives the identifier for the text definition.
- identifier
val identifier: TextIdentifier
Added in version 8.0.0
The unique identifier for this component.
- location
var location: Quadrilateral?
Added in version 8.0.0
The expected location of the text.
- optional
var optional:
BooleanAdded in version 8.0.0
Whether the text is optional.
- semantics
var semantics: ScanComponentTextSemanticType
Added in version 8.0.0
A semantic type to be applied to the text definition.
- hiddenProperties
var hiddenProperties: String
Added in version 8.0.0
A list of hidden properties to set on the text definition.
- valueRegexes
var valueRegexes: List<String>
Added in version 8.0.0
A list of value regex to use when searching for the text.
- anchorRegexes
var anchorRegexes: List<String>
Added in version 8.0.0
A list of anchor regexes to use when searching for the text.
- builder(identifier)
fun TextDefinition.builder(identifier: TextIdentifier): TextDefinitionBuilder
Added in version 8.0.0
Creates a builder object that can be used to fluently create a TextDefinition instance.