@blockchaincommons/multipart-ur - v1.0.0-beta.3
    Preparing search index...

    Interface FrameOptions

    How a UR is split into fountain-coded frames, plus how each frame is drawn.

    interface FrameOptions {
        maxFragmentLen?: number;
        cycles?: number;
        frameCount?: number;
        maxModules?: number;
        correction?: CorrectionLevel;
        size?: number;
        foreground?: ColorInput;
        background?: ColorInput;
        quietZone?: number;
        logo?: Logo | null;
    }

    Hierarchy (View Summary)

    Index
    maxFragmentLen? cycles? frameCount? maxModules? correction? size? foreground? background? quietZone? logo?
    maxFragmentLen?: number

    Largest fragment in bytes, a positive integer (default 40).

    cycles?: number

    Complete passes over the fragments, a non-negative integer (default 3); ignored when frameCount is set.

    frameCount?: number

    Exact number of frames, a non-negative integer; must be at least the fragment count.

    maxModules?: number

    When set, the first frame's module count must not exceed this (QrCodeTooDense).

    correction?: CorrectionLevel

    Error-correction level (default "high" with a logo, otherwise "low").

    size?: number

    Output width and height in pixels, a positive integer (default 512).

    foreground?: ColorInput

    Module colour, a Color or a hex string (default black).

    background?: ColorInput

    Background colour, a Color or a hex string (default white).

    quietZone?: number

    Blank modules around the code, a non-negative integer (default 1).

    logo?: Logo | null

    A logo composited over the centre.

    Settings
    Member Visibility

    On This Page
    Properties