Barcode Check Icon Annotation

Defined under the namespace Scandit.Datacapture.Barcode.Check.Ui

BarcodeCheckInfoAnnotationWidthPreset

Added in version 7.1.0

The available width options for an info annotation.

Small

Added in version 7.1.0

Small width. Recommended for annotations that contain only text or icon, and do not include a header or footer.

Medium

Added in version 7.1.0

Medium width.

Large

Added in version 7.1.0

Large width.

BarcodeCheckInfoAnnotationAnchor

Added in version 7.1.0

The available anchor options for an info annotation.

Left

Added in version 7.1.0

The annotation is anchored at its left edge.

Right

Added in version 7.1.0

The annotation is anchored at its right edge.

Bottom

Added in version 7.1.0

The annotation is anchored at its bottom-center point.

Top

Added in version 7.1.0

The annotation is anchored at its top-center point.

BarcodeCheckInfoAnnotationListener

interface BarcodeCheckInfoAnnotationListener

Added in version 7.1.0

The listener for the info annotation.

didTapHeader(annotation)

didTapHeader(annotation: BarcodeCheckInfoAnnotation): void

Added in version 7.1.0

Called when the annotation header is tapped. Called only if BarcodeCheckInfoAnnotation.isEntireAnnotationTappable is false.

didTapFooter(annotation)

didTapFooter(annotation: BarcodeCheckInfoAnnotation): void

Added in version 7.1.0

Called when the annotation footer is tapped. Called only if BarcodeCheckInfoAnnotation.isEntireAnnotationTappable is false.

didTapLeftIcon(annotation, component, componentIndex)

didTapLeftIcon(annotation: BarcodeCheckInfoAnnotation,
        component: BarcodeCheckInfoAnnotationBodyComponent,
        componentIndex: number): void

Added in version 7.1.0

Called when the left icon of an annotation component is tapped. componentIndex specifies the index of the component containing the tapped icon within the BarcodeCheckInfoAnnotation.body array. Called only if BarcodeCheckInfoAnnotation.isEntireAnnotationTappable is false.

didTapRightIcon(annotation, component, componentIndex)

didTapRightIcon(annotation: BarcodeCheckInfoAnnotation,
        component: BarcodeCheckInfoAnnotationBodyComponent,
        componentIndex: number): void

Added in version 7.1.0

Called when the right icon of an annotation component is tapped. componentIndex specifies the index of the component containing the tapped icon within the BarcodeCheckInfoAnnotation.body array. Called only if BarcodeCheckInfoAnnotation.isEntireAnnotationTappable is false.

didTap(annotation)

didTap(annotation: BarcodeCheckInfoAnnotation): void

Added in version 7.1.0

Called when the annotation is tapped. Called only if BarcodeCheckInfoAnnotation.isEntireAnnotationTappable is true.

BarcodeCheckInfoAnnotation

class BarcodeCheckInfoAnnotation : BarcodeCheckAnnotation

Added in version 7.1.0

Info annotations are tooltips that display text and icons, structured as an array of body components. Each body component contains text and may include optional tappable icons on both the left and right sides.

In addition to the body components, info annotations can include an optional header, and footer. By default, they appear automatically when the corresponding barcode is scanned. Info annotations are available in three predefined widths, with their height dynamically adjusting to fit the content. Here are some examples:

Body component only.	Body component and header.	Body component with attributed text and tappable icon.

constructor(barcode)

constructor(barcode: Barcode)

Added in version 7.1.0

Constructs a new instance with the given barcode.

barcode

get barcode(): Barcode

Added in version 7.1.0

The barcode instance for the annotation.

hasTip

hasTip: boolean

Added in version 7.1.0

Whether the annotation has a tip. The default value is true.

isEntireAnnotationTappable

isEntireAnnotationTappable: boolean

Added in version 7.1.0

If false, each individual element within the annotation (header, footer, icons in body components) is tappable. If true, the entire annotation is tappable.

anchor

anchor: BarcodeCheckInfoAnnotationAnchor

Added in version 7.1.0

The annotation anchor. The default value is BarcodeCheckInfoAnnotationAnchor.Bottom.

annotationTrigger

annotationTrigger: BarcodeCheckAnnotationTrigger

Added in version 7.1.0

The trigger that causes the annotation to be presented. By default is BarcodeCheckAnnotationTrigger.HighlightTapAndBarcodeScan.

width

width: BarcodeCheckInfoAnnotationWidthPreset

Added in version 7.1.0

The annotation width. The default value is BarcodeCheckInfoAnnotationWidthPreset.Small.

body

body: ReadonlyArray<BarcodeCheckInfoAnnotationBodyComponent>

Added in version 7.1.0

The annotation body, represented as an array of body components. The default value is [].

header

header: BarcodeCheckInfoAnnotationHeader | null

Added in version 7.1.0

The annotation header. The default value is null.

footer

footer: BarcodeCheckInfoAnnotationFooter | null

Added in version 7.1.0

The annotation footer. The default value is null.

backgroundColor

backgroundColor: Color

Added in version 7.1.0

The background color. The default value is #CCFFFFFF.

listener

listener: BarcodeCheckInfoAnnotationListener | null

Added in version 7.1.0

An object that receives notifications for UI-related events.