Barcode Ar Icon Annotation

Defined in framework ScanditBarcodeCapture

SDCBarcodeArInfoAnnotationWidthPreset

Added in version 7.1.0

The available width options for an info annotation.

SDCBarcodeArInfoAnnotationWidthPresetSmall

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.

SDCBarcodeArInfoAnnotationWidthPresetMedium

Added in version 7.1.0

Medium width.

SDCBarcodeArInfoAnnotationWidthPresetLarge

Added in version 7.1.0

Large width.

SDCBarcodeArInfoAnnotationAnchor

Added in version 7.1.0

The available anchor options for an info annotation.

SDCBarcodeArInfoAnnotationAnchorLeft

Added in version 7.1.0

The annotation is anchored at its left edge.

SDCBarcodeArInfoAnnotationAnchorRight

Added in version 7.1.0

The annotation is anchored at its right edge.

SDCBarcodeArInfoAnnotationAnchorBottom

Added in version 7.1.0

The annotation is anchored at its bottom-center point.

SDCBarcodeArInfoAnnotationAnchorTop

Added in version 7.1.0

The annotation is anchored at its top-center point.

SDCBarcodeArInfoAnnotationDelegate
@protocol SDCBarcodeArInfoAnnotationDelegate <NSObject>

Added in version 7.1.0

The delegate for the info annotation.

- barcodeArInfoAnnotationDidTapHeader:
- (void)barcodeArInfoAnnotationDidTapHeader:(SDCBarcodeArInfoAnnotation *)annotation

Added in version 7.1.0

Called when the annotation header is tapped. Called only if SDCBarcodeArInfoAnnotation.isEntireAnnotationTappable is NO.

- barcodeArInfoAnnotationDidTapFooter:
- (void)barcodeArInfoAnnotationDidTapFooter:(SDCBarcodeArInfoAnnotation *)annotation

Added in version 7.1.0

Called when the annotation footer is tapped. Called only if SDCBarcodeArInfoAnnotation.isEntireAnnotationTappable is NO.

- barcodeArInfoAnnotation:didTapLeftIconForComponent:at:
- (void)barcodeArInfoAnnotation:(SDCBarcodeArInfoAnnotation *)annotation
     didTapLeftIconForComponent:(SDCBarcodeArInfoAnnotationBodyComponent *)component
                             at:(NSInteger)componentIndex

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 SDCBarcodeArInfoAnnotation.body array. Called only if SDCBarcodeArInfoAnnotation.isEntireAnnotationTappable is NO.

- barcodeArInfoAnnotation:didTapRightIconForComponent:at:
- (void)barcodeArInfoAnnotation:(SDCBarcodeArInfoAnnotation *)annotation
    didTapRightIconForComponent:(SDCBarcodeArInfoAnnotationBodyComponent *)component
                             at:(NSInteger)componentIndex

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 SDCBarcodeArInfoAnnotation.body array. Called only if SDCBarcodeArInfoAnnotation.isEntireAnnotationTappable is NO.

- barcodeArInfoAnnotationDidTap:
- (void)barcodeArInfoAnnotationDidTap:(SDCBarcodeArInfoAnnotation *)annotation

Added in version 7.1.0

Called when the annotation is tapped. Called only if SDCBarcodeArInfoAnnotation.isEntireAnnotationTappable is YES.

SDCBarcodeArInfoAnnotation
@interface SDCBarcodeArInfoAnnotation : UIView <SDCBarcodeArAnnotation>

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:

../../../_images/info_annotation_without_header.png ../../../_images/info_annotation_with_header.png ../../../_images/info_annotation_with_button.png

Body component only.

Body component and header.

Body component with attributed text and tappable icon.
- initWithBarcode:
- (nonnull instancetype)initWithBarcode:(SDCBarcode *)barcode

Added in version 7.1.0

Constructs a new instance with the given barcode.

barcode
@property (nonatomic, strong, readonly) SDCBarcode *barcode

Added in version 7.1.0

The barcode instance for the annotation.

hasTip
@property (nonatomic, assign) BOOL hasTip

Added in version 7.1.0

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

isEntireAnnotationTappable
@property (nonatomic, assign) BOOL isEntireAnnotationTappable

Added in version 7.1.0

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

anchor
@property (nonatomic, assign) SDCBarcodeArInfoAnnotationAnchor anchor

Added in version 7.1.0

The annotation anchor. The default value is SDCBarcodeArInfoAnnotationAnchorBottom.

width
@property (nonatomic, assign) SDCBarcodeArInfoAnnotationWidthPreset width

Added in version 7.1.0

The annotation width. The default value is SDCBarcodeArInfoAnnotationWidthPresetSmall.

body
@property (nonatomic, strong) NSArray<SDCBarcodeArInfoAnnotationBodyComponent *> *body

Added in version 7.1.0

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

header
@property (nonatomic, strong, nullable) SDCBarcodeArInfoAnnotationHeader *header

Added in version 7.1.0

The annotation header. The default value is nil.

footer
@property (nonatomic, strong, nullable) SDCBarcodeArInfoAnnotationFooter *footer

Added in version 7.1.0

The annotation footer. The default value is nil.

backgroundColor
@property (nonatomic, strong) UIColor *backgroundColor

Added in version 7.1.0

The background color. The default value is white.

delegate
@property (nonatomic, weak) id<SDCBarcodeArInfoAnnotationDelegate> delegate

Added in version 7.1.0

An object that receives notifications for UI-related events.