AdaCAD Library Documentation - v1.1.4
    Preparing search index...

    Interface InitDraftParams

    A helper interface that can be passed to on draft creation to apply specific settings. This type will commonly be called when using the InitDraftWithParams function as in:

    //initialize a 10 x 10 draft with all cells set to heddle down. 
    const draft = initDraftWithParams({wefts: 10, warps: 10, drawdown: [[false]]});

    a unqiue id

    a generated name for this draft

    a user defined name for this draft

    a number of wefts to be used in this draft, will be used to generate a drawdown of a predefined size

    a number of warps to be used in this draft, will be used to generate a drawdown of a predefined size

    a drawdown to be used in the generated draft. The pattern represented in this value will be repeated over the number of warps and wefts specified.

    support for a legacy format whereby a draft was a 2D array of booleans, instead of a 2D array of cells

    an array representing a sequence of shuttle/mateials ids to be associated with each weft pick.

    an array representing a sequence of shuttle/mateials ids to be associated with each warp end.

    an array representing a sequence of system ids to be associated with each weft pick.

    an array representing a sequence of system ids to be associated with each warp end.

    interface InitDraftParams {
        colShuttleMapping?: number[];
        colSystemMapping?: number[];
        drawdown?: Drawdown;
        gen_name?: string;
        id?: number;
        pattern?: boolean[][];
        rowShuttleMapping?: number[];
        rowSystemMapping?: number[];
        ud_name?: string;
        warps?: number;
        wefts?: number;
    }
    Index

    Properties

    colShuttleMapping?: number[]
    colSystemMapping?: number[]
    drawdown?: Drawdown
    gen_name?: string
    id?: number
    pattern?: boolean[][]
    rowShuttleMapping?: number[]
    rowSystemMapping?: number[]
    ud_name?: string
    warps?: number
    wefts?: number