capacitor-plugin-scanbot-sdk/dist/esm/ui_v2/dde/DocumentDataExtractorUserGuidance.d.ts

Scanbot Document and Barcode Scanner SDK for Capacitor

import { BackgroundStyle, StyledText } from '../../ui_v2/common/Common';
import type { DeepPartial } from '../../utils/utils';
import { PartiallyConstructible } from '../../utils/utils';
/**
Configure the captions of the user guidance hints for different scanning states.
*/
export declare class DocumentDataExtractorGuidanceStates extends PartiallyConstructible {
    /**
      The user guidance text displayed when no document is found. Initial state.
      
      Default is "?documentUserGuidanceNoDocumentFound"
      */
    noDocumentFound: string;
    /**
      The user guidance text displayed when a document presence was detected and scanning is in progress.
      
      Default is "?documentUserGuidanceScanningProgress"
      */
    scanningProgress: string;
    /**
      The user guidance text displayed when it is too dark to capture an adequate image.
      
      Default is "?documentUserGuidanceTooDark"
      */
    tooDark: string;
    /**
      The user guidance text displayed when the detected document is too far away and appears too small.
      
      Default is "?documentUserGuidanceTooSmall"
      */
    tooSmall: string;
    /**
      The user guidance text displayed when the detected document is not in a good perspective (device tilted).
      
      Default is "?documentUserGuidanceBadPerspective"
      */
    badPerspective: string;
    /** @param source {@displayType `DeepPartial<DocumentDataExtractorGuidanceStates>`} */
    constructor(source?: DeepPartial<DocumentDataExtractorGuidanceStates>);
}
/**
Configuration of the hints guiding users through the document scanning process.
*/
export declare class DocumentDataExtractorGuidanceConfiguration extends PartiallyConstructible {
    /**
      Determines whether the user guidance hints should be visible (enabled).
      
      Default is true
      */
    visibility: boolean;
    /**
      Configure the text style for the user guidance hints.
      */
    title: StyledText;
    /**
      Configure the background style for the user guidance hints.
      */
    background: BackgroundStyle;
    /**
      Configure the captions of the user guidance hints for different states.
      */
    statesTitles: DocumentDataExtractorGuidanceStates;
    /** @param source {@displayType `DeepPartial<DocumentDataExtractorGuidanceConfiguration>`} */
    constructor(source?: DeepPartial<DocumentDataExtractorGuidanceConfiguration>);
}