Options
All
  • Public
  • Public/Protected
  • All
Menu

A symbology-specific configuration object.

See http://docs.scandit.com/stable/c_api/symbologies.html for more details.

Hierarchy

  • SymbologySettings

Index

Constructors

constructor

  • Creates a SymbologySettings instance.

    Parameters

    • Default value __namedParameters: object = {}
      • activeSymbolCounts: number[]

        Default = undefined  (default symbology range)
        The list of active symbol counts.

      • checksums: null | Checksum[] | Set<Checksum>

        Default = undefined  (default symbology checksums)
        The list/set of enabled checksums.

      • colorInvertedEnabled: boolean

        Default = false
        Whether color inverted recognition is enabled.

      • enabled: boolean

        Default = false
        Whether the symbology is enabled for recognition.

      • extensions: null | Extension[] | Set<Extension>

        Default = undefined  (default symbology extensions)
        The list/set of enabled extensions.

    Returns SymbologySettings

Methods

disableChecksums

disableExtensions

enableChecksums

enableExtensions

getActiveSymbolCounts

  • getActiveSymbolCounts(): number[]
  • Get the currently set custom list of active symbol counts. If never set, an empty array is returned but the Scandit Engine library will use the default list for the symbology.

    Returns number[]

    The list of active symbol counts.

getEnabledChecksums

  • Get the currently set custom set of checksums. If never set, an empty set is returned but the Scandit Engine library will use the default checksum set for the symbology.

    Returns Set<Checksum>

    The set of enabled checksums.

getEnabledExtensions

  • Get the currently set custom set of extensions. If never set, an empty set is returned but the Scandit Engine library will use the default extension set for the symbology.

    Returns Set<Extension>

    The set of enabled extensions.

isColorInvertedEnabled

  • isColorInvertedEnabled(): boolean
  • Returns boolean

    Whether color inverted recognition is enabled.

isEnabled

  • isEnabled(): boolean
  • Returns boolean

    Whether the symbology enabled for recognition.

setActiveSymbolCounts

  • Set the list of active symbol counts.

    Parameters

    • activeSymbolCounts: number[]

      The list of active symbol counts.

    Returns SymbologySettings

    The updated SymbologySettings object.

setActiveSymbolCountsRange

  • Set the range of active symbol counts.

    Parameters

    • minCount: number

      The minimum accepted number of symbols.

    • maxCount: number

      The minimum accepted number of symbols.

    Returns SymbologySettings

    The updated SymbologySettings object.

setColorInvertedEnabled

  • Enable or disable recognition of inverted-color symbology (in addition to normal colors).

    Parameters

    • enabled: boolean

      Whether color inverted recognition is enabled.

    Returns SymbologySettings

    The updated SymbologySettings object.

setEnabled

  • Enable or disable recognition of the symbology.

    Parameters

    • enabled: boolean

      Whether the symbology is enabled for recognition.

    Returns SymbologySettings

    The updated SymbologySettings object.

Protected toJSON

  • toJSON(): object
  • Returns object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc