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

    Type Alias DocumentDisplacement

    DocumentDisplacement:
        | "NONE"
        | "UP"
        | "UPPER_RIGHT"
        | "RIGHT"
        | "LOWER_RIGHT"
        | "DOWN"
        | "LOWER_LEFT"
        | "LEFT"
        | "UPPER_LEFT"

    The direction towards the center of the document if the document is partially visible.

    • NONE: The document is fully visible.
    • UP: The document is partially visible. Move the camera up to capture the full document.
    • UPPER_RIGHT: The document is partially visible. Move the camera up and to the right to capture the full document.
    • RIGHT: The document is partially visible. Move the camera to the right to capture the full document.
    • LOWER_RIGHT: The document is partially visible. Move the camera down and to the right to capture the full document.
    • DOWN: The document is partially visible. Move the camera down to capture the full document.
    • LOWER_LEFT: The document is partially visible. Move the camera down and to the left to capture the full document.
    • LEFT: The document is partially visible. Move the camera to the left to capture the full document.
    • UPPER_LEFT: The document is partially visible. Move the camera up and to the left to capture the full document.

    Type Declaration

    • "NONE"

      The document is fully visible.

    • "UP"

      The document is partially visible. Move the camera up to capture the full document.

    • "UPPER_RIGHT"

      The document is partially visible. Move the camera up and to the right to capture the full document.

    • "RIGHT"

      The document is partially visible. Move the camera to the right to capture the full document.

    • "LOWER_RIGHT"

      The document is partially visible. Move the camera down and to the right to capture the full document.

    • "DOWN"

      The document is partially visible. Move the camera down to capture the full document.

    • "LOWER_LEFT"

      The document is partially visible. Move the camera down and to the left to capture the full document.

    • "LEFT"

      The document is partially visible. Move the camera to the left to capture the full document.

    • "UPPER_LEFT"

      The document is partially visible. Move the camera up and to the left to capture the full document.