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

Scanbot Document and Barcode Scanner SDK for Capacitor

import { ButtonConfiguration, StyledText } from '../../ui_v2/common/Common';
import type { DeepPartial } from '../../utils/utils';
import { PartiallyConstructible } from '../../utils/utils';
/**
The image for the introduction screen of a document data extractor screen.
*/
export type DocumentDataExtractorIntroImage = DocumentDataIntroDefaultImage | DocumentDataIntroNoImage | DocumentDataIntroCustomImage;
/**
The image for the introduction screen featuring a document.
*/
export declare class DocumentDataIntroDefaultImage extends PartiallyConstructible {
    readonly _type: 'DocumentDataIntroDefaultImage';
    /** @param source {@displayType `DeepPartial<DocumentDataIntroDefaultImage>`} */
    constructor(source?: DeepPartial<DocumentDataIntroDefaultImage>);
}
/**
No image for the introduction screen.
*/
export declare class DocumentDataIntroNoImage extends PartiallyConstructible {
    readonly _type: 'DocumentDataIntroNoImage';
    /** @param source {@displayType `DeepPartial<DocumentDataIntroNoImage>`} */
    constructor(source?: DeepPartial<DocumentDataIntroNoImage>);
}
/**
A custom image for the introduction screen.
*/
export declare class DocumentDataIntroCustomImage extends PartiallyConstructible {
    readonly _type: 'DocumentDataIntroCustomImage';
    /**
      The web or file URI to the image.
      */
    uri: string;
    /** @param source {@displayType `DeepPartial<DocumentDataIntroCustomImage>`} */
    constructor(source?: DeepPartial<DocumentDataIntroCustomImage>);
}
/**
Configuration of the introduction screen for the document data extractor.
*/
export declare class DocumentDataExtractorIntroScreenConfiguration extends PartiallyConstructible {
    /**
      The image for the introduction screen.
      */
    image: DocumentDataExtractorIntroImage;
    /**
      The background color of the introduction screen.
      
      Default is "?sbColorSurface"
      */
    backgroundColor: string;
    /**
      The divider color of the introduction screen.
      
      Default is "?sbColorOutline"
      */
    dividerColor: string;
    /**
      The handle color of the introduction screen.
      
      Default is "?sbColorOutline"
      */
    handlerColor: string;
    /**
      Determines whether the introduction screen should automatically be shown or not when the scanning session starts.
      
      Default is false
      */
    showAutomatically: boolean;
    /**
      The title of the introduction screen, located in the top bar.
      */
    title: StyledText;
    /**
      The text explanation of the introduction screen.
      */
    explanation: StyledText;
    /**
      Configuration of the 'Done' / 'Start scanning' button.
      */
    doneButton: ButtonConfiguration;
    /** @param source {@displayType `DeepPartial<DocumentDataExtractorIntroScreenConfiguration>`} */
    constructor(source?: DeepPartial<DocumentDataExtractorIntroScreenConfiguration>);
}