Skip to content

LayoutInput

Defined in: packages/fingerprint/src/types.ts:87

layoutFingerprint’s one argument. The items array is treated as immutable: work is cached against it, so pass a new array when the collection changes.

dimensions: readonly Dimension[]

Defined in: packages/fingerprint/src/types.ts:91

Every dimension the items carry values for; the encoding picks among them.


optional encoding?: Encoding

Defined in: packages/fingerprint/src/types.ts:68

Which dimension drives what. Defaults to the first dimension arranging, colouring and shaping.

LayoutOptions.encoding


optional form?: Partial<FingerprintForm>

Defined in: packages/fingerprint/src/types.ts:72

Overrides the print’s form. formFromItems derives one from the data.

LayoutOptions.form


items: readonly Item[]

Defined in: packages/fingerprint/src/types.ts:89

One per mark (below the cap). Unique ids.


optional maxMarks?: number

Defined in: packages/fingerprint/src/types.ts:78

Above this many items, marks stand for several items each. Defaults to 600, the most marks a canvas glides smoothly (see FingerprintCanvas’s motion); raise it for denser prints. A layout can exceed it slightly, since every combination of encoded categories needs a mark.

LayoutOptions.maxMarks


optional minRidges?: number

Defined in: packages/fingerprint/src/types.ts:80

Ridges never sit further apart than the frame’s half-width divided by this. Defaults to 6.

LayoutOptions.minRidges


optional seed?: string

Defined in: packages/fingerprint/src/types.ts:70

Seeds any form field not given, and nothing else. Same seed, same picture.

LayoutOptions.seed