Class BaseCustomUIComponent<T, K>`Abstract`

Type Parameters

T
K

Hierarchy (View Summary)

BaseCustomUIComponent
- BarcodeCustomUIComponent
- DocumentCustomUIComponent

Index

Methods

attachScannerAtFrame attachScannerOnElement detachScannerView freezeCamera unfreezeCamera updateScannerViewFrame updateScannerViewFrameFromElement

Methods

attachScannerAtFrame

attachScannerAtFrame(
    frame: ScannerViewFrame,
    resultHandlers: T,
    initialConfiguration?: K,
): Promise<void>
Attach the scanner at frame
Parameters
- frame: ScannerViewFrame
- resultHandlers: T
- OptionalinitialConfiguration: K
Returns Promise<void>

attachScannerOnElement

attachScannerOnElement(
    element: HTMLElement,
    sendToBack: boolean,
    resultHandlers: T,
    initialConfiguration?: K,
): Promise<void>
Attach the scanner view on top of an HTMLElement
Parameters
- element: HTMLElement
- sendToBack: boolean
- resultHandlers: T
- OptionalinitialConfiguration: K
Returns Promise<void>

detachScannerView

detachScannerView(): Promise<void>
Detaches the scanner view and stops the camera preview

Returns Promise<void>

freezeCamera

freezeCamera(): Promise<void>
Freezes the camera preview

Returns Promise<void>

unfreezeCamera

unfreezeCamera(): Promise<void>
Unfreezes the previously frozen camera preview

Returns Promise<void>

updateScannerViewFrame

updateScannerViewFrame(params: ScannerViewFrame): Promise<void>
Update the scanner view frame
Parameters
- params: ScannerViewFrame
Returns Promise<void>

updateScannerViewFrameFromElement

updateScannerViewFrameFromElement(
params: HTMLElement,
sendToBack: boolean,
): Promise<void>
Update the scanner view frame
Parameters
- params: HTMLElement
- sendToBack: boolean
Returns Promise<void>