Skip to main content

Interface: InitDraftParams

Defined in: draft/types.ts:131

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]]});

Param​

a unqiue id

Param​

a generated name for this draft

Param​

a user defined name for this draft

Param​

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

Param​

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

Param​

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.

Param​

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

Param​

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

Param​

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

Param​

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

Param​

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

Properties​

colShuttleMapping?​

optional colShuttleMapping: number[]

Defined in: draft/types.ts:141

colSystemMapping?​

optional colSystemMapping: number[]

Defined in: draft/types.ts:142

drawdown?​

optional drawdown: Drawdown

Defined in: draft/types.ts:137

gen_name?​

optional gen_name: string

Defined in: draft/types.ts:133

id?​

optional id: number

Defined in: draft/types.ts:132

pattern?​

optional pattern: boolean[][]

Defined in: draft/types.ts:138

rowShuttleMapping?​

optional rowShuttleMapping: number[]

Defined in: draft/types.ts:139

rowSystemMapping?​

optional rowSystemMapping: number[]

Defined in: draft/types.ts:140

ud_name?​

optional ud_name: string

Defined in: draft/types.ts:134

warps?​

optional warps: number

Defined in: draft/types.ts:136

wefts?​

optional wefts: number

Defined in: draft/types.ts:135