Barcode AR Popover Annotation

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

BarcodeArPopoverAnnotationAnchor

Added in version 8.6.0

The available anchor options for a popover annotation.

Left

Added in version 8.6.0

The annotation is anchored at its left edge.

Right

Added in version 8.6.0

The annotation is anchored at its right edge.

Bottom

Added in version 8.6.0

The annotation is anchored at its bottom-center point.

Top

Added in version 8.6.0

The annotation is anchored at its top-center point.

BarcodeArPopoverAnnotationListener

interface BarcodeArPopoverAnnotationListener

Added in version 8.2.0

The listener for the popover annotation.

didTapButton(popover, button, buttonIndex)

didTapButton?(popover: BarcodeArPopoverAnnotation,
        button: BarcodeArPopoverAnnotationButton,
        buttonIndex: number): void

Added in version 8.2.0

Called when a button is tapped. The buttonIndex parameter can be used to identify which button was tapped. Called only if BarcodeArPopoverAnnotation.isEntirePopoverTappable is false.

didTap(popover)

didTap?(popover: BarcodeArPopoverAnnotation): void

Added in version 8.2.0

Called when the popover is tapped. Called only if BarcodeArPopoverAnnotation.isEntirePopoverTappable is true.

BarcodeArPopoverAnnotation

class BarcodeArPopoverAnnotation : BarcodeArAnnotation

Added in version 8.2.0

An annotation comprising a set of buttons, each containing an icon and text, which appears only when the user taps on the corresponding barcode highlight.

constructor(barcode, buttons)

constructor(barcode: Barcode,
        buttons: BarcodeArPopoverAnnotationButton[])

Added in version 8.2.0

Constructs a new instance with the given buttons and barcode.

isEntirePopoverTappable

isEntirePopoverTappable: boolean

Added in version 8.2.0

If false each individual button in the popover is tappable. If true the entire popover is tappable. Default is false.

anchor

anchor: BarcodeArPopoverAnnotationAnchor

Added in version 8.6.0

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

listener

listener: BarcodeArPopoverAnnotationListener | null

Added in version 8.2.0

An object that receives notifications for UI-related events, such as tapping on a button.

annotationTrigger

annotationTrigger: BarcodeArAnnotationTrigger

Added in version 8.2.0

The trigger that causes the annotation to be presented. By default is BarcodeArAnnotationTrigger.HighlightTap.

buttons

get buttons(): ReadonlyArray<BarcodeArPopoverAnnotationButton>

Added in version 8.2.0

Returns the buttons provided in the constructor.

barcode

get barcode(): Barcode

Added in version 8.2.0

Returns the barcode provided in the constructor.

BarcodeArPopoverAnnotationButton

class BarcodeArPopoverAnnotationButton

Added in version 8.2.0

constructor(icon, text)

constructor(icon: ScanditIcon,
        text: string)

Added in version 8.2.0

Constructs a new instance with the given icon and text.

textColor

textColor: Color

Added in version 8.2.0

The color of the text. Default is #3D4852.

textSize

textSize: number

Added in version 8.2.0

The size of the text. Default is 10 scale-independent pixels.

fontFamily

fontFamily: FontFamily

Added in version 8.2.0

The font used for the text.

icon

get icon(): ScanditIcon

Added in version 8.2.0

The icon provided in the constructor.

text

get text(): string

Added in version 8.2.0

The text provided in the constructor.

enabled

enabled: boolean

Added in version 8.6.0

Whether the button is enabled. Default is true.