Label Symbology Settings
Defined under the namespace Scandit.Datacapture.Label
- LabelSymbologySettings
class LabelSymbologySettingsAdded in version 8.7.0
Settings specific to a particular barcode symbology, scoped to a single LabelCaptureSettings instance.
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.
Checksum configuration (available on other platforms as
GetChecksumBits/SetChecksumBits) is not available on Web.- symbology
readonly symbology: Symbology
Added in version 8.7.0
The symbology that this symbology settings affect.
- isEnabled()
isEnabled(): Promise<boolean>
Added in version 8.7.0
By default decoding of all symbologies is disabled. To enable decoding of this symbology, set setEnabled() to true. It is advised to only enable symbologies that are required by the application as every enabled symbology adds processing overhead.
- setEnabled(enabled)
setEnabled(enabled: boolean): Promise<
void>Added in version 8.7.0
This method only enables decoding of dark codes on bright background. If color-inverted (bright on dark) codes for this symbology are required, enable them by calling setColorInvertedEnabled().
- isColorInvertedEnabled()
isColorInvertedEnabled(): Promise<boolean>
Added in version 8.7.0
Determines whether decoding of color-inverted (bright on dark) codes for this symbology is enabled. By default, decoding of color inverted codes is disabled.
- setColorInvertedEnabled(enabled)
setColorInvertedEnabled(enabled: boolean): Promise<
void>Added in version 8.7.0
Currently, isEnabled() will also have to return true for bright on dark codes to be scanned, though this may change in a future release.
- isExtensionEnabled(extension)
isExtensionEnabled(extension: string): Promise<boolean>
Added in version 8.7.0
Checks if the extension is enabled.
- getEnabledExtensions()
getEnabledExtensions(): Promise<string[]>
Added in version 8.7.0
The set of enabled extensions of this symbology. Extensions allow to configure features that are specific to a small number of symbologies. For example, there is an extension to configure how to treat the leading zero for UPC-A codes. For a list of supported extensions, refer to Symbology Properties.
- setExtensionEnabled(extension, enabled)
setExtensionEnabled(extension: string, enabled: boolean): Promise<
void>Added in version 8.7.0
Activates/Deactivates a custom extension for the symbology.
- getActiveSymbolCounts()
getActiveSymbolCounts(): Promise<number[]>
Added in version 8.7.0
The active symbol counts of the symbology, e.g. the supported length of barcodes to be decoded. For other symbologies, refer to Symbology Properties.
- setActiveSymbolCounts(activeSymbolCounts)
setActiveSymbolCounts(activeSymbolCounts: number[]): Promise<
void>Added in version 8.7.0
Change the active symbol counts to include symbol counts that are not enabled by default, or to optimize decoding performance for a certain number of symbols.
The provided active symbol count values are intersected with the supported active symbol count values of the symbology. Values that are not part of the supported symbol count range are ignored.