Label Capture Settings

Defined under the namespace Scandit.Datacapture.Label

LabelCaptureSettings
class LabelCaptureSettings

Added in version 6.5.0

Configures label capture parameters and defines the structure of labels to be captured. This settings object is central to the Smart Label Capture workflow, specifying which label definitions to use, recognition parameters, and capture behavior.

Key configuration aspects:

  • Label definitions - Defines field types (barcodes, dates, text) and their validation rules

  • Recognition parameters - Controls scanning behavior and accuracy

  • Location selection - Specifies scanning areas and constraints

  • Symbology settings - Configures which barcode types are enabled

The settings follow a fluent builder pattern for convenient configuration and support multiple label definitions to handle different types of labels in the same scanning session. For the settings to take effect, they must be applied to a label capture instance using the appropriate apply settings method.

settingsFromLabelDefinitions(definitions, properties)
static settingsFromLabelDefinitions(definitions: LabelDefinition[],
        properties: object<string, string> | null): LabelCaptureSettings

Added in version 6.22.0

Load the settings from an array of LabelDefinition with optional hidden properties

fromJSON(json)
static fromJSON(json: object<string, any>): LabelCaptureSettings | null

Added in version 6.5.0

Load the settings from a JSON object representation of a label blueprint, provided to you by Scandit.

Deprecated since version 6.22: Deprecated in favour of a new way to initialize this class using LabelDefinition

setProperty(name, value)
setProperty(name: string,
        value: any): void

Added in version 6.5.0

Sets a property to the provided value. Use this method to set properties that are not yet part of a stable API. Properties set through this method may change in a future release.

getProperty(name)
getProperty(name: string): any

Added in version 6.5.0

Retrieves the value of a previously set property. In case the property does not exist, null is returned. Use this method to get properties that are not yet part of a stable API. These properties may change in a future release.

settingsForSymbology(symbology)
settingsForSymbology(symbology: Symbology): SymbologySettings

Added in version 7.4.0

Get SymbologySettings specific for the given Symbology.

Note that modifying the returned object doesn’t automatically apply the changes to LabelCapture. After you made changes to the symbology settings, call LabelCapture.applySettings() with these LabelCaptureSettings to apply them.