Interface Configuration

BarcodeReader configuration object.

interface Configuration {
    engine?: EngineConfiguration;
    feedback?: FeedbackConfiguration;
    frameSource?: FrameSourceConfiguration;
    locator?: LocatorConfiguration;
    mode?: "immediate" | "touch";
    overlay?: OverlayConfiguration;
    selector: undefined | string | HTMLElement;
}

Properties

engine? feedback? frameSource? locator? mode? overlay? selector

Properties

Optional engine

engine?: EngineConfiguration

Engine configuration

Optional feedback

feedback?: FeedbackConfiguration

Feedback configuration

Optional frameSource

frameSource?: FrameSourceConfiguration

Frame source configuration

Optional locator

locator?: LocatorConfiguration

Locator configuration

Optional mode

mode?: "immediate" | "touch"

Mode: can be 'immediate' (default) for always-on scanning, and 'touch', to only scan when a touch occurs.

Default Value

immediate

Optional overlay

overlay?: OverlayConfiguration

Overlay configuration

selector

selector: undefined | string | HTMLElement

CSS Selector or reference to the HTML element that will host the visible elements of the BarcodeReader.

Remarks

When using a selector, make sure the selector only matches a single element, e.g. by using an ID. When using the popup scanner, do not pass a selector.

Settings

Member Visibility

Theme

On This Page

enginefeedbackframeSourcelocatormodeoverlayselector