Coursereader API - v0.1.0
    Preparing search index...

    Interface ScanSettings

    Scan and reproduction settings shared by pages and viewers.

    Numeric amounts normally run from 0 to 1, where 0 disables the effect and 1 applies its full strength.

    interface ScanSettings {
        artifacts: {
            bleedThrough: number;
            dust: number;
            edgeNoise: number;
            grain: number;
            horizontalBands: number;
            scratches: number;
            shineThrough: number;
            verticalStreaks: number;
        };
        border: {
            darkness: number;
            enabled: boolean;
            roughness: number;
            sides: { bottom: boolean; left: boolean; right: boolean; top: boolean };
            thickness: number;
        };
        capture: {
            grayscale: boolean;
            perspective: number;
            rotation: number;
            rotationJitter: number;
        };
        exposure: {
            blownHighlights: number;
            brightness: number;
            contrast: number;
            crushedShadows: number;
            gamma: number;
            unevenness: number;
        };
        ink: { blur: number; erosion: number; spread: number };
        paper: { texture: number; tone: number };
        tone: {
            dither: DitherMode;
            ditherAmount: number;
            levels: number;
            mode: ToneMode;
            threshold: number;
        };
    }
    Index
    artifacts border capture exposure ink paper tone
    artifacts: {
        bleedThrough: number;
        dust: number;
        edgeNoise: number;
        grain: number;
        horizontalBands: number;
        scratches: number;
        shineThrough: number;
        verticalStreaks: number;
    }

    Type Declaration

    • bleedThrough: number

      Amount of ink bleeding through from the reverse side, from 0 to 1.

    • dust: number

      Density of dust specks from 0 to 1.

    • edgeNoise: number

      Noise along the sheet edges from 0 to 1.

    • grain: number

      Amount of photographic grain from 0 to 1.

    • horizontalBands: number

      Amount of horizontal banding from 0 to 1.

    • scratches: number

      Density of scratches from 0 to 1.

    • shineThrough: number

      Ghost of the reverse side showing through the sheet, from 0 to 1.

    • verticalStreaks: number

      Density of vertical copy streaks from 0 to 1.

    border: {
        darkness: number;
        enabled: boolean;
        roughness: number;
        sides: { bottom: boolean; left: boolean; right: boolean; top: boolean };
        thickness: number;
    }

    Type Declaration

    • darkness: number

      Frame darkness from 0 to 1.

    • enabled: boolean

      Whether to draw the copier frame around the sheet.

    • roughness: number

      Irregularity of the frame edges from 0 to 1.

    • sides: { bottom: boolean; left: boolean; right: boolean; top: boolean }

      Which sides of the sheet receive the frame. Spreads suppress the binding side so that facing pages meet at the spine.

    • thickness: number

      Frame thickness in pixels.

    capture: {
        grayscale: boolean;
        perspective: number;
        rotation: number;
        rotationJitter: number;
    }

    Type Declaration

    • grayscale: boolean

      Convert the content to grayscale before tone treatment.

    • perspective: number

      Perspective or keystone distortion from 0 to 1.

    • rotation: number

      Fixed page rotation in degrees.

    • rotationJitter: number

      Seeded random rotation jitter from 0 to 1. Adds a small random misalignment on top of the fixed rotation, different for every seed.

    exposure: {
        blownHighlights: number;
        brightness: number;
        contrast: number;
        crushedShadows: number;
        gamma: number;
        unevenness: number;
    }

    Type Declaration

    • blownHighlights: number

      Highlight clipping from 0 to 1. Higher values turn more bright areas pure white.

    • brightness: number

      Overall brightness multiplier. 1 leaves the image unchanged.

    • contrast: number

      Contrast multiplier. 1 leaves the image unchanged.

    • crushedShadows: number

      Shadow clipping from 0 to 1. Higher values turn more dark areas pure black.

    • gamma: number

      Gamma adjustment. Values below 1 darken midtones and values above 1 lighten them.

    • unevenness: number

      Uneven illumination across the sheet from 0 to 1.

    ink: { blur: number; erosion: number; spread: number }

    Type Declaration

    • blur: number

      Softening of dark marks from 0 to 1.

    • erosion: number

      Contraction of dark marks from 0 to 1.

    • spread: number

      Expansion of dark marks from 0 to 1.

    paper: { texture: number; tone: number }

    Type Declaration

    • texture: number

      Subtle visual paper texture from 0 to 1.

    • tone: number

      Paper luminance from 0 to 1.

    tone: {
        dither: DitherMode;
        ditherAmount: number;
        levels: number;
        mode: ToneMode;
        threshold: number;
    }

    Type Declaration

    • dither: DitherMode

      Dither pattern applied before tone reduction.

    • ditherAmount: number

      Dither strength from 0 to 1.

    • levels: number

      Number of gray levels from 2 to 256 in quantized mode.

    • mode: ToneMode

      Tone reduction mode.

    • threshold: number

      Bitonal threshold from 0 to 1. Higher values produce more black.

    Settings
    Member Visibility

    On This Page
    Properties