capacitor-plugin-scanbot-sdk
    Preparing search index...

    Interface Page

    SDK Page

    interface Page {
        detectionResult: DocumentDetectionStatus;
        documentImageFileUri?: string;
        documentImageSizeLimit?: Size;
        documentPreviewImageFileUri?: string;
        filter: ImageFilterType;
        originalImageFileUri: string;
        originalPreviewImageFileUri: string;
        pageId: string;
        pageImageSource: PageImageSource;
        parametricFilters?: ParametricFilter[];
        polygon: PolygonPoint[];
    }
    Index

    Properties

    detectionResult documentImageFileUri? documentImageSizeLimit? documentPreviewImageFileUri? filter originalImageFileUri originalPreviewImageFileUri pageId pageImageSource parametricFilters? polygon

    Properties

    detectionResult: DocumentDetectionStatus

    The document detection result status for the operation that produced the page

    documentImageFileUri?: string

    File URI of the cropped document image (if document detection was successful)

    documentImageSizeLimit?: Size

    The value that was set for documentImageSizeLimit, which limits the maximum size of the document image.

    documentPreviewImageFileUri?: string

    File URI of a screen-sized preview of the document image (if document detection was successful)

    filter: ImageFilterType

    The Image Filter that was applied on the page image.

    Use parametricFilters instead.

    originalImageFileUri: string

    File URI of the original image

    originalPreviewImageFileUri: string

    File URI of a screen-sized preview of the original image

    pageId: string

    A string identifying the page in the internal page file storage

    pageImageSource: PageImageSource

    The image source

    parametricFilters?: ParametricFilter[]

    The Image Filters that are applied on the page image

    polygon: PolygonPoint[]

    The page's cropping polygon as calculated by a document detection operation or as set by the cropping UI. Modifying the polygon will change the polygon as shown in the cropping UI but will not automatically re-crop the original image

    Settings

    Member Visibility

    On This Page

    Properties